Domains
Domains in the management API. 8 endpoints.
Read the guideOpenAPI 3.1 document
Try it settings
https://api.bifrostorbit.com/cms/manage/v1
The management API takes a management token, which is secret and acts as a person, so nothing here is sent from the docs.
Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.
The space's domains
GET/organisations/{organisationId}/spaces/{spaceId}/domainsKey required
The space's domains. Permission: domain:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OKList of domains.dataDomain[]Fields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
hostnamestringSuch as northwilds.com.
pathPrefixstring or nullSuch as /no.
primarybooleanverifiedbooleanverificationTokenstring or nullAdd it as a TXT record on the hostname or on _cms-orbit.<hostname>, then verify.
createdAtstringupdatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:read.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such space, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/domains' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": [ { "_id": "6650f1c2a9e4b1d2c3f40a46", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "environmentId": "6650f1c2a9e4b1d2c3f40a13", "regionId": "6650f1c2a9e4b1d2c3f40a17", "localeId": "6650f1c2a9e4b1d2c3f40a18", "hostname": "northwilds.com", "pathPrefix": null, "primary": true, "verified": true, "verificationToken": "cms-orbit-verify=4b1d2c3f", "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" } ]}Adds a domain: hostname, environmentId (required), regionId, localeId, pathPrefix, primary
POST/organisations/{organisationId}/spaces/{spaceId}/domainsKey required
Adds a domain: hostname, environmentId (required), regionId, localeId, pathPrefix, primary. Permission: domain:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body
hostnamestringrequiredSuch as northwilds.com.
environmentIdanyrequiredThe environment it serves. Required.
regionIdanyoptionalThe region it opens in.
localeIdanyoptionalThe language it opens in.
pathPrefixstring or nulloptionalA folder, such as /no, for a domain shared between regions.
primarybooleanoptionalOnly a verified domain can be primary.
Responses
201CreatedThe domain and its verificationToken.dataDomainFields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
hostnamestringSuch as northwilds.com.
pathPrefixstring or nullSuch as /no.
primarybooleanverifiedbooleanverificationTokenstring or nullAdd it as a TXT record on the hostname or on _cms-orbit.<hostname>, then verify.
createdAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or not a hostname or a folder.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundThe environment, region or language isn't in this space.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
409ConflictAnother space uses the hostname.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/domains' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"hostname":"northwilds.com","environmentId":"6650f1c2a9e4b1d2c3f40a13"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "_id": "6650f1c2a9e4b1d2c3f40a46", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "environmentId": "6650f1c2a9e4b1d2c3f40a13", "regionId": "6650f1c2a9e4b1d2c3f40a17", "localeId": "6650f1c2a9e4b1d2c3f40a18", "hostname": "northwilds.com", "pathPrefix": null, "primary": true, "verified": true, "verificationToken": "cms-orbit-verify=4b1d2c3f", "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}Removes a domain
DELETE/organisations/{organisationId}/spaces/{spaceId}/domains/{domainId}Key required
Removes a domain. Permission: domain:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
domainIdstringpath, requiredThe domain's id.
Responses
204No contentDone, nothing to return.401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such domain, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/domains/6650f1c2a9e4b1d2c3f40a30' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Changes primary or pathPrefix
PATCH/organisations/{organisationId}/spaces/{spaceId}/domains/{domainId}Key required
Changes primary or pathPrefix. Permission: domain:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
domainIdstringpath, requiredThe domain's id.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body, optional
primarybooleanoptionalOnly a verified domain can be primary.
pathPrefixstring or nulloptionalSuch as /no, or null for none.
Responses
200OKThe domain.dataDomainFields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
hostnamestringSuch as northwilds.com.
pathPrefixstring or nullSuch as /no.
primarybooleanverifiedbooleanverificationTokenstring or nullAdd it as a TXT record on the hostname or on _cms-orbit.<hostname>, then verify.
createdAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or making an unverified domain primary, or a folder that isn't valid.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such domain, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
422UnprocessableA field of the wrong type.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/domains/6650f1c2a9e4b1d2c3f40a30' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"primary":true}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "_id": "6650f1c2a9e4b1d2c3f40a46", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "environmentId": "6650f1c2a9e4b1d2c3f40a13", "regionId": "6650f1c2a9e4b1d2c3f40a17", "localeId": "6650f1c2a9e4b1d2c3f40a18", "hostname": "northwilds.com", "pathPrefix": null, "primary": true, "verified": true, "verificationToken": "cms-orbit-verify=4b1d2c3f", "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}Looks for the TXT record
POST/organisations/{organisationId}/spaces/{spaceId}/domains/{domainId}/verifyKey required
Looks for the TXT record. Permission: domain:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
domainIdstringpath, requiredThe domain's id.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Responses
200OK{ verified, message }.dataobjectFields of data
verifiedbooleanA failed check still answers 200, with false.
messagestringWhat was found.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such domain, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/domains/6650f1c2a9e4b1d2c3f40a30/verify' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "verified": true, "message": "…" }}Removes it
DELETE/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/media-hostKey required
Removes it. Permission: domain:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
Responses
204No contentDone, nothing to return.401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such environment, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/media-host' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
The environment's own address for media, with its status
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/media-hostKey required
The environment's own address for media, with its status. Permission: domain:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
Responses
200OKThe media host, or null.dataMediaHost or any or nullFields of data
One of:
MediaHost
environmentIdstringAn id.
hostnamestringSuch as media.northwilds.com.
targetstringWhere the CNAME record points.
One of pending, active, failed.statusstringmessagestring or nullcheckedAtstring or nullcloudflareIdstring or nullonWebsitebooleansometimesThe website's own server answers on the hostname.
any or null
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:read.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such environment, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/media-host' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "environmentId": "6650f1c2a9e4b1d2c3f40a13", "hostname": "media.northwilds.com", "target": "media.bifrostorbit.com", "status": "pending", "message": null, "checkedAt": "2026-11-02T09:30:00.000Z", "cloudflareId": null, "onWebsite": false }}Sets it: { "hostname": "media.northwilds.com" }
PUT/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/media-hostKey required
Sets it: { "hostname": "media.northwilds.com" }. Permission: domain:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body
hostnamestringrequiredSuch as media.northwilds.com. Empty removes it.
Responses
200OKThe media host.dataMediaHost or any or nullFields of data
One of:
MediaHost
environmentIdstringAn id.
hostnamestringSuch as media.northwilds.com.
targetstringWhere the CNAME record points.
One of pending, active, failed.statusstringmessagestring or nullcheckedAtstring or nullcloudflareIdstring or nullonWebsitebooleansometimesThe website's own server answers on the hostname.
any or null
400Bad requestThe body isn't valid JSON. Or not a hostname on a domain the space uses, or Cloudflare refused it.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks domain:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such environment, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
409ConflictAnother space uses the hostname.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/media-host' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"hostname":"media.northwilds.com"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "environmentId": "6650f1c2a9e4b1d2c3f40a13", "hostname": "media.northwilds.com", "target": "media.bifrostorbit.com", "status": "pending", "message": null, "checkedAt": "2026-11-02T09:30:00.000Z", "cloudflareId": null, "onWebsite": false }}SchemasThe shapes the endpoints above answer with and take.
Error
Every error has this shape. Write code against code and the status, never the message.
errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
Domain
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
hostnamestringSuch as northwilds.com.
pathPrefixstring or nullSuch as /no.
primarybooleanverifiedbooleanverificationTokenstring or nullAdd it as a TXT record on the hostname or on _cms-orbit.<hostname>, then verify.
createdAtstringupdatedAtstring
MediaHost
environmentIdstringAn id.
hostnamestringSuch as media.northwilds.com.
targetstringWhere the CNAME record points.
One of pending, active, failed.statusstringmessagestring or nullcheckedAtstring or nullcloudflareIdstring or nullonWebsitebooleansometimesThe website's own server answers on the hostname.