minimusdocs
Help center

Packages

List packages

GET/management/packages/

read Read: looks, changes nothing. Scopes

Packages you can see, a page at a time, by name: every package for a panel operator; for a reseller, those their groups may sell and those they built, with what they pay for each (my_price).

Query parameters

  • mineboolean

    Only the ones you built yourself.

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Matches the name or the description.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)requiredread-only
    • namestringrequiredread-only
    • descriptionstringrequiredread-onlycan be null
    • is_enabledbooleanrequiredread-only
    • is_trialbooleanrequiredread-only

      Trial package: lines created from it are marked as trials.

    • credit_coststring (decimal)requiredread-only

      What a reseller pays, in credits, for a line on this package (new or extended). 0 = free. A reseller's own price, when one is set, is used instead.

    • duration_valueintegerrequiredread-only

      Duration value (number of hours or days)

    • duration_typestringrequiredread-only
    • max_connectionsintegerrequiredread-only

      Simultaneous connections granted to lines created from this package.

    • is_restreamerbooleanrequiredread-only

      Authorized-restream package: lines are marked as restreamers.

    • forced_countriesstringrequiredread-only

      Comma-separated ISO country codes (e.g. FR,MA). Empty = no country restriction.

    • lock_to_ispbooleanrequiredread-only

      Lock the line to the ISP seen on its first connection.

    • forced_serverstring (uuid)requiredread-onlycan be null

      Force lines to stream from this server instead of auto routing.

    • forced_server_namestringrequiredread-only
    • output_formatsstringrequiredread-only

      Comma-separated allowed delivery formats (hls, mpegts, rtmp). Empty = all.

    • allowed_groupsinteger[]requiredread-only

      Groups that can assign this package to line users

    • allowed_groups_dataobject[]requiredread-only
      • idintegerrequired
      • namestringrequired
    • bouquets_countintegerrequiredread-only
    • bouquet_idsstring[]requiredread-only
    • my_pricestringrequiredread-onlycan be null
    • my_price_sourcestringrequiredread-onlycan be null
    • created_bystring (uuid)requiredread-onlycan be null

      User who created this package

    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
    • updated_atstring (date-time)requiredread-only

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means