Deployments.ai Docs
Apps

List an app's custom domains and the DNS records each one needs

GET /v1/apps/{appId}/domains · SDK listAppDomains · CLI deployments app-domain list

GET
/v1/apps/{appId}/domains

Requires apps:read; admits human and service-account callers.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

appId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Query Parameters

cursor?string
Length1 <= length <= 4096
limit?integer
Range1 <= value <= 100

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListAppDomainsResponse

application/json
  1. response
items*array<>
nextCursor?|null|null
curl -X GET "https://example.com/v1/apps/string/domains" \  -H "x-deployments-environment: string"
{  "items": [    {      "appId": "string",      "attachedBy": {        "id": "string",        "principal": "human"      },      "createdAt": "2019-08-24T14:15:22Z",      "dnsRecords": [        {          "name": "string",          "note": "string",          "type": "CNAME",          "value": "string"        }      ],      "hostname": "string",      "id": "string",      "state": {        "kind": "unverified"      },      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}