Reference / Settings

add a domain; returns the DNS records to publish. Emits `custom_domain.added`.

POST /v1/applications/{id}/domains
Secret API key operationId: add

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

  • id string<uuid> required

    Application id

Request body · required

  • domain string required

Responses

200 Added (pending verification)
{
  "data": {
    "created_at": "2026-01-15T09:30:00Z",
    "dns_records": {},
    "domain": "string",
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "status": "string",
    "tls_status": "string",
    "verified_at": "2026-01-15T09:30:00Z"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}
409 Domain already configured
422 Invalid domain

Request

curl -X POST "http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/domains" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "string"
}'

Try it

live request
POST http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/domains

Path parameters

Request body

application/json