Skip to main content
POST
Attach custom domain

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

kind
string
required
Allowed value: "app"
appUuid
string<uuid>
required

Identifier of the app this custom domain attaches to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
hostname
string
required

Customer-controlled subdomain to attach (e.g. app.example.com). Must be a valid FQDN with at least three DNS labels, must not include a protocol or path, and must not be under a Cargo-owned domain. Normalised to lowercase.

Required string length: 4 - 253

Response

Successful response

customDomain
Custom domain · object
required

Newly attached custom domain.