Atlas
Admin — Custom Domain

Add a custom domain

Register a custom domain for the current workspace. Enterprise plan required (self-hosted is always allowed). One domain per workspace.

POST
/api/v1/admin/domain

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3001/api/v1/admin/domain" \  -H "Content-Type: application/json" \  -d '{    "domain": "data.acme.com"  }'
{
  "id": "string",
  "workspaceId": "string",
  "domain": "string",
  "status": "pending",
  "railwayDomainId": "string",
  "cnameTarget": "string",
  "certificateStatus": "PENDING",
  "verificationToken": "string",
  "domainVerified": true,
  "domainVerifiedAt": "string",
  "domainVerificationStatus": "pending",
  "createdAt": "string",
  "verifiedAt": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
Edit on GitHub

Last updated on