minimusdocs
Help center

Resellers

List resellers' domains

GET/resellers/domains/

read Read: looks, changes nothing. Scopes

Every reseller, their domain and where their lines' links point, a page at a time. For panel operators allowed to manage resellers' domains.

Query parameters

  • 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 username or the domain.

  • with_domainboolean

    true: only resellers with a domain.

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)required
    • usernamestringrequired
    • parentstringrequiredcan be null

      The reseller above, if any.

    • domainobjectrequiredcan be null
      • namestringrequired
      • statusstringrequired
        • pending - Waiting for DNS
        • certificate - Getting a certificate
        • active - Active
        • trouble - Not answering

        One of: "pending" "certificate" "active" "trouble"

      • status_textstringrequired
      • detailstringrequired

        What the last check found.

      • servingstringrequired

        The name links use now; empty until this one works.

      • checked_atstring (date-time)requiredcan be null
      • next_check_atstring (date-time)requiredcan be null
      • changed_bystringrequiredcan be null
      • changed_atstring (date-time)required
    • usesobjectrequired
      • namestringrequired

        The domain links use; empty for the panel's own address.

      • originstringrequired

        The start of every link, like https://tv.example.com.

      • fromstringrequiredcan be null

        The account above whose domain is used, when it is not their own.

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