Publishing
Publishing 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.
Publishes a banner at once on every page, past approval
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/emergency-publishKey required
Publishes a banner at once on every page, past approval. Permission: emergency:publish.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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
reasonstringrequiredWhy it can't wait, 5 to 300 characters. Recorded in the audit log.
Responses
200OKThe item.dataContentOne piece of content with its draft.
Fields of data
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
400Bad requestThe body isn't valid JSON. Or no reason, a reason over 300 characters, or content that isn't a banner.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 emergency:publish, 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/emergency-publish' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"reason":"The Tromsø ferry is cancelled today because of the storm."}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a21", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z", "urlOverride": null, "draft": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "canonical": null, "noIndex": false, "ogTitle": null, "ogDescription": null, "ogImage": null, "twitterTitle": null, "twitterDescription": null, "twitterImage": null, "noFollow": false, "breadcrumbLabel": null, "sitemapExclude": false, "sitemapChangeFrequency": "always", "sitemapPriority": 0 }, "updatedAt": "2026-11-02T09:30:00.000Z", "updatedBy": "6650f1c2a9e4b1d2c3f40a30" }, "draftVersion": 12, "publishedVersion": 12, "docVersion": 12 }}Copies the published version to another environment and publishes it there
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/promoteKey required
Copies the published version to another environment and publishes it there. Permission: content:publish in both.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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
targetEnvironmentIdstringrequiredThe environment to publish it in, such as production.
Responses
200OK{ contentId, targetContentId, targetEnvironment, created }.dataobjectFields of data
contentIdstringAn id.
targetContentIdstringIts id in the other environment.
targetEnvironmentstringThe other environment's name.
createdbooleanIt didn't exist there before.
400Bad requestThe body isn't valid JSON. Or the same environment, or the other environment lacks the region or language.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 content:publish here or there.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 content item, 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.
409ConflictIt isn't published here, or another page uses the address there.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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/promote' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"targetEnvironmentId":"6650f1c2a9e4b1d2c3f40a14"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "contentId": "6650f1c2a9e4b1d2c3f40a21", "targetContentId": "6650f1c2a9e4b1d2c3f40a5f", "targetEnvironment": "…", "created": true }}Promotes every published entry in a folder or language to another environment, with their redirects
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/promoteKey required
Promotes every published entry in a folder or language to another environment, with their redirects. Permission: content:publish in both, redirect:manage for redirects.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language'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
targetEnvironmentIdstringrequiredThe environment to publish in, such as production.
folderIdstring or nulloptionalPromote this folder and every folder in it. Leave it out, or send null, for every entry in this language.
redirectsbooleanoptionalAlso copy the redirects to the pages promoted, or for a whole language every redirect in it. Needs redirect:manage; without it they are left out and redirectsSkipped is true.
Default true.dryRunbooleanoptionalAnswer what would happen without changing anything.
Default false.afterstring or nulloptionalThe next value of the previous answer. Each call handles up to 100 entries, fewer when they take more than 30 seconds.
Responses
200OK{ dryRun, target, total, items, next, redirects, redirectsSkipped }.dataobjectFields of data
dryRunbooleantargetstringThe other environment's name.
totalintegerEntries in the folder or language, across every call.
itemsobject[]The entries handled by this call.
Fields of items
contentIdstringAn id.
namestringurlstring or nulloutcomestringunchanged when the other environment already has what is published here; notPublished entries are left out.
One of create, update, unchanged, notPublished, error.messagestring or nullWhy it failed.
nextstring or nullSend it as after to handle the next 100. null on the last call.
redirectsobject or nullOn the last call, when redirects is true.
Fields of redirects
createintegerupdateintegerunchangedintegererrorinteger
redirectsSkippedbooleanRedirects were asked for without redirect:manage.
400Bad requestThe body isn't valid JSON. Or the same environment, or the other environment lacks the region or language.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 content:publish here or there.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 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.
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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/promote' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"targetEnvironmentId":"6650f1c2a9e4b1d2c3f40a14","folderId":"6650f1c2a9e4b1d2c3f40a20","dryRun":true}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "dryRun": false, "target": "…", "total": 4, "items": [ { "contentId": "6650f1c2a9e4b1d2c3f40a21", "name": "Lofoten sea kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking", "outcome": "create", "message": null } ], "next": null, "redirects": { "create": 1, "update": 1, "unchanged": 1, "error": 1 }, "redirectsSkipped": false }}Publishes the draft
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/publishKey required
Publishes the draft. Permission: content:publish.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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
changeSummarystring or nulloptionalWhat changed, shown in the history.
Up to 300 characters.summaryKindstringoptionalUsed by the CMS screens.
One of siteSettings, allSiteSettings.accessibilityOverrideobjectoptionalPublish despite accessibility problems that would block it. Needs space:update.
Fields of accessibilityOverride
Up to 500 characters.reasonstringrequired
expectedDraftVersionintegeroptionalThe draftVersion you last read. If the page changed since, the answer is 409 draft_changed and nothing is published.
At least 0.
Responses
200OKThe item, with redirect.dataobjectThe item, with the redirect publishing added.
Fields of data
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
redirectobject or nullThe redirect added because the address changed, when the space adds them.
Fields of redirect
idstringAn id.
sourcestringdestinationstring
400Bad requestThe body isn't valid JSON.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 content:publish, or the plan's limits.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 content item, 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.
409ConflictNothing new to publish, it needs approval or sign-off, a check blocks it (details.blockers), or accessibility problems block it (details.accessibility and details.canOverride).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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/publish' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"changeSummary":"New departures for 2027."}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a40", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "https://northwilds.com/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "…", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z", "urlOverride": null, "draft": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "canonical": null, "noIndex": false, "ogTitle": null, "ogDescription": null, "ogImage": null, "twitterTitle": null, "twitterDescription": null, "twitterImage": null, "noFollow": false, "breadcrumbLabel": null, "sitemapExclude": false, "sitemapChangeFrequency": "always", "sitemapPriority": 0 }, "updatedAt": "2026-11-02T09:30:00.000Z", "updatedBy": "6650f1c2a9e4b1d2c3f40a30" }, "draftVersion": 12, "publishedVersion": 12, "docVersion": 12, "redirect": { "id": "6650f1c2a9e4b1d2c3f40a40", "source": "…", "destination": "…" } }}Puts an earlier revision back
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/rollbackKey required
Puts an earlier revision back. Permission: content:rollback.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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
revisionIdstringrequiredThe revision to put back. When the page is live, it's published straight away.
Up to 300 characters.changeSummarystring or nulloptional
Responses
200OKThe item.dataContentOne piece of content with its draft.
Fields of data
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
400Bad requestThe body isn't valid JSON.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 content:rollback, 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 content item, 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.
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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/rollback' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"revisionId":"6650f1c2a9e4b1d2c3f40a30","changeSummary":"Back to the summer prices."}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a21", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z", "urlOverride": null, "draft": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "canonical": null, "noIndex": false, "ogTitle": null, "ogDescription": null, "ogImage": null, "twitterTitle": null, "twitterDescription": null, "twitterImage": null, "noFollow": false, "breadcrumbLabel": null, "sitemapExclude": false, "sitemapChangeFrequency": "always", "sitemapPriority": 0 }, "updatedAt": "2026-11-02T09:30:00.000Z", "updatedBy": "6650f1c2a9e4b1d2c3f40a30" }, "draftVersion": 12, "publishedVersion": 12, "docVersion": 12 }}Its scheduled publishing and unpublishing
GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/scheduleKey required
Its scheduled publishing and unpublishing. Permission: release:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item's id.
Responses
200OK[{ releaseId, action, at, sharedWith }].dataSchedule[]Fields of data
releaseIdstringThe release it's in.
One of publish, unpublish.actionstringatstringsharedWithintegerOther pages in the same release.
400Bad requestNot a content id.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 release: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 content item, 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/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/schedule' \ -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": [ { "releaseId": "6650f1c2a9e4b1d2c3f40a59", "action": "publish", "at": "2026-11-02T09:30:00.000Z", "sharedWith": 1 } ]}Publishes or unpublishes it at a time
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/scheduleKey required
Publishes or unpublishes it at a time. Permission: content:publish or content:unpublish, and release:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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
atstringrequiredWhen, in the future, ISO 8601 with a time zone. Required.
actionstringoptionalDefault publish.
One of publish, unpublish.
Responses
201Created{ releaseId, action, at, sharedWith }.dataScheduleFields of data
releaseIdstringThe release it's in.
One of publish, unpublish.actionstringatstringsharedWithintegerOther pages in the same release.
400Bad requestThe body isn't valid JSON. Or no date and time, or one in the past.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 content:publish or content:unpublish, release:manage, or the plan has no releases.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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/schedule' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"at":"2026-12-01T08:00:00Z","action":"publish"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "releaseId": "6650f1c2a9e4b1d2c3f40a59", "action": "publish", "at": "2026-11-02T09:30:00.000Z", "sharedWith": 1 }}Takes it off the website
POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/unpublishKey required
Takes it off the website. redirectTo adds a redirect. Permission: content:unpublish.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringpath, requiredThe environment's id.
regionIdstringpath, requiredThe region's id.
localeIdstringpath, requiredThe language's id.
contentIdstringpath, requiredThe content item'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
redirectTostring or nulloptionalAlso add a redirect from its address to this one, such as /trips.
Responses
200OKThe item.dataContentOne piece of content with its draft.
Fields of data
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
400Bad requestThe body isn't valid JSON.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 content:unpublish, 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 content item, 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.
409ConflictIt isn't published, is scheduled, or is in a release.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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/unpublish' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"redirectTo":"/trips"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a21", "name": "Lofoten sea kayaking", "slug": "lofoten-sea-kayaking", "url": "/trips/lofoten-sea-kayaking", "status": "draft", "contentTypeKey": "trip", "folderId": "6650f1c2a9e4b1d2c3f40a20", "externalId": null, "isGlobal": false, "isFolderIndex": false, "updatedAt": "2026-11-02T09:30:00.000Z", "publishedAt": "2026-11-02T09:30:00.000Z", "urlOverride": null, "draft": { "fields": {}, "components": [ { "id": "hero-1", "type": "hero", "schemaVersion": 12, "fields": { "heading": "Paddle the Lofoten fjords" }, "children": {}, "variant": null } ], "seo": { "title": "Lofoten sea kayaking", "description": "Six days of paddling between the peaks of Lofoten.", "canonical": null, "noIndex": false, "ogTitle": null, "ogDescription": null, "ogImage": null, "twitterTitle": null, "twitterDescription": null, "twitterImage": null, "noFollow": false, "breadcrumbLabel": null, "sitemapExclude": false, "sitemapChangeFrequency": "always", "sitemapPriority": 0 }, "updatedAt": "2026-11-02T09:30:00.000Z", "updatedBy": "6650f1c2a9e4b1d2c3f40a30" }, "draftVersion": 12, "publishedVersion": 12, "docVersion": 12 }}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.
Block
One block in a page body.
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
Fields of children
idstringtypestringThe component's key, such as hero.
schemaVersionintegerfieldsmap of anyThe component's fields.
childrenmap of Block[]Further blocks by slot.
variantstring or null
variantstring or null
variantstring or null
variantstring or null
Content
One piece of content with its draft.
idstringAn id.
namestringslugstringurlstring or null
One of draft, in_review, published, scheduled, archived.statusstringcontentTypeKeystringfolderIdstring or nullAn id.
externalIdstring or nullisGlobalbooleanisFolderIndexbooleanupdatedAtstringpublishedAtstring or nullurlOverridestring or nulldraftobjectThe draft. No seo for content without an address.
Fields of draft
fieldsmap of anyField values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.
componentsBlock[]seoobjectsometimesFields of seo
titlestring or nulldescriptionstring or nullcanonicalstring or nullnoIndexbooleanogTitlestring or nullogDescriptionstring or nullogImagestring or nullA media id or address.
twitterTitlestring or nulltwitterDescriptionstring or nulltwitterImagestring or nullnoFollowbooleanbreadcrumbLabelstring or nullsitemapExcludeboolean
One of always, hourly, daily, weekly, monthly, yearly, never.sitemapChangeFrequencystring or null
At least 0. At most 1.sitemapPrioritynumber or null
updatedAtstringupdatedBystringAn id.
draftVersionintegerpublishedVersionintegerCompare with draftVersion to see whether the draft has unpublished changes.
docVersionintegerSend it back with each save, so a save never overwrites changes you haven't seen.
Schedule
releaseIdstringThe release it's in.
One of publish, unpublish.actionstringatstringsharedWithintegerOther pages in the same release.