Deployments.ai Docs
Command reference

deployments app-domain

Custom hostnames that serve an app once their DNS records are published

CommandSummary
deployments app-domain listList an app's custom domains and the DNS records each one needs
deployments app-domain attachAttach a hostname to an app and print the DNS records to publish (needs apps:publish)
deployments app-domain refreshCheck a domain's DNS TXT record, queue its edge setup, and report its state
deployments app-domain detachDetach 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 (SDK listAppDomains).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<appId>positionalyesApp 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 (SDK attachAppDomain).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<appId>positionalyesApp ID
--hostnamestringyesHostname, 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>
FlagTypeRequiredDefaultDescription
<appId>positionalyesApp ID
<domainId>positionalyesDomain 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} (SDK detachAppDomain).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<appId>positionalyesApp ID
<domainId>positionalyesDomain ID

Also accepts the global flags.

On this page