Domains

Add a custom domain.

Registers a custom domain for the caller's project and returns the created record plus the DNS records (CNAME + TXT) needed to verify and serve it.

post/v1/domains

Request

  • Base URL: https://api.scalix.world
  • URL: https://api.scalix.world/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

Fully-qualified domain to attach, e.g. app.example.com.

run_servicestring nullable

Optional Scalix Run service (by name) this domain should serve. When set, requests to the domain are proxied to the service exactly like {name}.run.scalix.world; when omitted, the domain serves the project's API surface. The service must belong to the caller's project.

storage_bucketstring nullable
function_namestring nullable

Optional Function (by globally-unique name) this domain serves. Requests to the domain invoke the function's HTTP handler exactly like {name}.fn.scalix.world. Mutually exclusive with the other targets.

Example request

{
  "domain": "app.example.com",
  "run_service": "my-frontend"
}

Response

Domain registered; returns DNS setup instructions

Changes

No recorded changes to this operation across all 1 revision of this API.