minimusdocs
Help center

Resellers

Get your domain

GET/resellers/domain/

read Read: looks, changes nothing. Scopes

Your own domain and its status, where your lines' links point now, and the DNS record to make. Resellers only: an operator sets a domain for a reseller instead.

Response

200 OK

  • accountobjectrequired

    {id, username}.

  • domainobjectrequiredcan be null

    Null when no domain is set.

    • 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

    Where this reseller's lines' links point now.

    • 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.

  • fallbackobjectrequired

    Where they would point without a domain of their own.

    • 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.

  • dnsobjectrequired

    The DNS record to make.

    • cnamestringrequired

      The panel's own name: point a subdomain at it (CNAME).

    • ipv4string[]required

      For a domain itself: A records.

    • ipv6string[]required

      For a domain itself: AAAA records.

    • portintegerrequired

      The port links use.

    • proxy_managedbooleanrequired

      Whether the panel gets the certificate itself.

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