List storefront domains

Returns the list of custom domains configured for the storefront.

Returns the list of custom domains configured for the storefront. Heroku-internal entries are filtered out. The Makaira-managed default domain is marked with kind: makaira.

Requires the storefront:domains:read or storefront.read permission.

Request

GET /storefront/domains

Headers

HeaderValue
AuthorizationBearer <token>

Response

Returns a JSON array of domain objects.

Response Body

Array of objects with the following fields:

FieldTypeDescription
idstringDomain identifier.
hostnamestringThe fully-qualified domain name.
kindstringDomain type. makaira for the built-in Makaira domain, custom for user-added domains.
statusstringCurrent DNS/SSL status (e.g. succeeded, pending).

Example Response

[
  {
    "id": "abc123",
    "hostname": "myshop-production.makaira.cloud",
    "kind": "makaira",
    "status": "succeeded"
  },
  {
    "id": "def456",
    "hostname": "www.myshop.com",
    "kind": "custom",
    "status": "succeeded"
  }
]
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json