Command reference
deployments app-domain
Custom hostnames that serve an app once their DNS records are published
| Command | Summary |
|---|---|
deployments app-domain list | List an app's custom domains and the DNS records each one needs |
deployments app-domain attach | Attach a hostname to an app and print the DNS records to publish (needs apps:publish) |
deployments app-domain refresh | Check a domain's DNS TXT record, queue its edge setup, and report its state |
deployments app-domain detach | Detach a custom domain from an app |
deployments app-domain list
List an app's custom domains and the DNS records each one needs.
deployments app-domain list <app-id>- Calls
GET /v1/apps/{appId}/domains(SDKlistAppDomains). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<appId> | positional | yes | App ID |
Also accepts the global flags.
deployments app-domain attach
Attach a hostname to an app and print the DNS records to publish (needs apps:publish).
deployments app-domain attach <app-id> --hostname <hostname>- Calls
POST /v1/apps/{appId}/domains(SDKattachAppDomain). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<appId> | positional | yes | App ID | |
--hostname | string | yes | Hostname, such as www.example.com |
Also accepts the global flags.
deployments app-domain refresh
Check a domain's DNS TXT record, queue its edge setup, and report its state.
deployments app-domain refresh <app-id> <domain-id>- Calls
POST /v1/apps/{appId}/domains/{domainId}/refresh(SDKrefreshAppDomain). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<appId> | positional | yes | App ID | |
<domainId> | positional | yes | Domain ID |
Also accepts the global flags.
deployments app-domain detach
Detach a custom domain from an app.
deployments app-domain detach <app-id> <domain-id>- Calls
DELETE /v1/apps/{appId}/domains/{domainId}(SDKdetachAppDomain). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<appId> | positional | yes | App ID | |
<domainId> | positional | yes | Domain ID |
Also accepts the global flags.