Skip to content

Rename a platform domain

Give a platform domain another name and check it again from the start.

Updated

patch

https://cloud.cahaves.com/api/domains/{id}

Authorization

cahaves.cloud.sessionstringcookierequired

The session cookie Cloud sets when a customer signs in to the console with GitHub or Google. It is HttpOnly, so scripts cannot read it, and there are no API keys or tokens yet.

Path parameters

idstring<uuid>required

Example: "7f3a1e9c-5d2b-4a8f-9e6c-1b0d3c5e7a2f"

Headers

X-Cloud-Organizationstring<uuid>

The id of the organization the request works in, one the signed-in customer owns. Left out or empty, the request works in their oldest organization. Any other value answers 404 with `reason: "organization"`. A customer with no organization yet gets 409 "Create an organization first." from every route that works in one.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Body

application/jsonrequired

subdomainstringrequired

Responses

application/json

The renamed domain, pending its checks.

domainobjectrequired

The old address stops answering at once; the new one answers once its certificate is issued. Sending the current name changes nothing.