Domains

Get a custom domain.

Returns a single custom domain by id, scoped to the caller's project.

get/v1/domains/{id}

Request

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

Path parameters

idstring required

Domain id

Response

The domain

idstring required
project_idstring required
domainstring required
domain_typestring required
statusstring required
verification_tokenstring required
ssl_statusstring required
ssl_expires_atstring required
ssl_issued_atstring required
ssl_errorstring nullable

Last cert-issuance failure reason (absent = none). Lets the console show "DNS doesn't point to our edge" instead of a silent stuck 'none'/'failed'.

primary_domainboolean required
created_atstring required
updated_atstring required
cname_targetstring nullable
run_servicestring nullable

Run service this domain serves (absent = the project's API surface).

storage_bucketstring nullable
function_namestring nullable

Function this domain serves (absent = not a function target).

edge_ipstring nullable

Gateway IP for apex A-record setup (absent if not configured).

Changes

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