Skip to main content
Prisma Documentation Docs

Search documentation

Type to search this documentation.

List custom domains for an app

GET/v1/apps/{appId}/domainsList custom domains for an app

⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Deprecated: use GET /v1/services/{serviceId}/domains instead.

Returns all custom domains attached to any deployment of the app. Domains are aggregated across all deployments since Foundry lists per deployment.

Parameters

appIdstringpathrequired

pattern ^(cps_)?([cC][^\s-]{8,}|[a-z0-9]+)$

Responses

200List of custom domains.application/json
object
dataarray of objectrequired
Show child attributes
Show array items
appIdstringrequired
certExpiresAtnull | string · date-timerequired
computeServiceIdstringrequired

Deprecated: use `appId` instead.

createdAtstring · date-timerequired
dnsRecordsarray of objectrequired
Show child attributes
Show array items
namestringrequired
ttlnull | numberrequired
typestringrequired

const "CNAME"

valuestringrequired
failureCategorynull | stringrequired

one of "dns", "acme", "storage", "unknown", null

failureReasonnull | stringrequired
foundryStatusstringrequired
hostnamestringrequired
idstringrequired
statusstringrequired

one of "pending_dns", "verifying", "verified_routing_blocked", "provisioning_tls", "active", "failed", "removing"

typestringrequired

const "custom-domain"

updatedAtstring · date-timerequired
urlstring · urirequired
paginationobjectrequired
Show child attributes
hasMorebooleanrequired

const false

nextCursornullrequired
Example response
{
  "data": [
    {
      "appId": "string",
      "certExpiresAt": "2026-06-09T00:00:00Z",
      "computeServiceId": "string",
      "createdAt": "2026-06-09T00:00:00Z",
      "dnsRecords": [
        {
          "name": "string",
          "ttl": 0,
          "type": "CNAME",
          "value": "string"
        }
      ],
      "failureCategory": "acme",
      "failureReason": "string",
      "foundryStatus": "string",
      "hostname": "string",
      "id": "string",
      "status": "active",
      "type": "custom-domain",
      "updatedAt": "2026-06-09T00:00:00Z",
      "url": "https://example.com"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}
401Missing or invalid authorization token.application/json
object
errorobjectrequired
Show child attributes
codestringrequired
hintstring
messagestringrequired
Example response
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
403Insufficient permissions.application/json
object
errorobjectrequired
Show child attributes
codestringrequired
hintstring
messagestringrequired
Example response
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
404App not found.application/json
object
errorobjectrequired
Show child attributes
codestringrequired
hintstring
messagestringrequired
Example response
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
429Rate limit exceeded.application/json
object
errorobjectrequired
Show child attributes
codestringrequired
hintstring
messagestringrequired
Example response
{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}
Documentation menu