Skip to content

Content

Content in the management API. 15 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 content at the top level, or in folderId

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/contentKey required

The content at the top level, or in folderId. Permission: content:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • folderIdstringquery

    A folder's id, or root for the top level. Leave it out for the top level.

  • urlstringquery

    Find content by its address instead. Answers a list with one summary, or an empty list.

  • externalIdstringquery

    Find content by your own id instead, such as its id in the system you migrate from. Repeat it for up to 500 ids. Answers a summary for each one found.

Responses

  • 200OKList of summaries.
    • dataContentSummary[]

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

        Such as /trips/lofoten-sea-kayaking. null for content without an address.

      • statusstring

        published once it has been published, even while the draft has changes.

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

        Your own id for the entry, such as its id in the system it was imported from. Unique in its language.

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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 language, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content' \  -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

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f40a4e",      "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"    }  ]}

Creates content as a draft

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/contentKey required

Creates content as a draft. Permission: content:create.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • dryRunstringquery

    true checks everything a create checks and answers what it would make, with id null, without saving.

    One of true, false.
  • Idempotency-Keystringheader

    Optional. 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

  • namestringrequired

    The name editors see, such as Lofoten sea kayaking.

    Up to 200 characters.
  • slugstringoptional

    The last part of the address. From the name when left out.

  • contentTypeKeystringrequired

    One of the space's content types.

    Up to 64 characters.
  • folderIdstring or nulloptional

    The folder it lives in. The folder must accept the content type.

  • urlOverridestring or nulloptional

    A whole address instead of folder and slug, such as /winter.

    Up to 500 characters.
  • fieldsmap of anyoptional

    Field values by key. See the field types guide.

    Default {}.
  • componentsany[]optional

    Blocks: each { id, type, fields, children, variant }, where children holds slots of further blocks. See the Block schema. Defaults to the content type's template.

    Default [].
  • seoobjectoptional

    Fields of seo
    • titlestring or nulloptional

      Default null. Up to 200 characters.
    • descriptionstring or nulloptional

      Default null. Up to 500 characters.
    • canonicalstring or nulloptional

      Default null. Up to 500 characters.
    • noIndexbooleanoptional

      Default false.
    • ogTitlestring or nulloptional

      Default null. Up to 200 characters.
    • ogDescriptionstring or nulloptional

      Default null. Up to 500 characters.
    • ogImagestring or nulloptional

      Default null. Up to 500 characters.
    • twitterTitlestring or nulloptional

      Default null. Up to 200 characters.
    • twitterDescriptionstring or nulloptional

      Default null. Up to 500 characters.
    • twitterImagestring or nulloptional

      Default null. Up to 500 characters.
    • noFollowbooleanoptional

      Default false.
    • breadcrumbLabelstring or nulloptional

      Default null. Up to 120 characters.
    • sitemapExcludebooleanoptional

      Default false.
    • sitemapChangeFrequencystring or nulloptional

      One of always, hourly, daily, weekly, monthly, yearly, never. Default null.
    • sitemapPrioritynumber or nulloptional

      Default null. At least 0. At most 1.
  • globalKeystring or nulloptional

    The key a global entry is read by, such as footer.

    Up to 64 characters.
  • externalIdstring or nulloptional

    Your own id for the entry, up to 200 characters, such as its id in the system you migrate from. Unique in this language: another entry with it answers 409.

    Up to 200 characters.
  • isFolderIndexbooleanoptional

    The folder's own page, at the folder's address.

    Default false.
  • sortOrderintegeroptional

    Default 0.

Responses

  • 201CreatedThe summary.
    • dataContentSummary

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

        Such as /trips/lofoten-sea-kayaking. null for content without an address.

      • statusstring

        published once it has been published, even while the draft has changes.

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

        Your own id for the entry, such as its id in the system it was imported from. Unique in its language.

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

  • 400Bad requestThe body isn't valid JSON. Or a field value breaks the content type's rules (each in details as { path, message }), the folder doesn't accept the content type, or a link points to a page in the bin or another space.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:create, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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 language, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

  • 409ConflictThe address or externalId is taken, or the content type allows one item and it exists.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Lofoten sea kayaking","contentTypeKey":"trip","folderId":"6650f1c2a9e4b1d2c3f40a20","fields":{"title":"Lofoten sea kayaking","days":6},"seo":{"description":"Six days of paddling between the peaks of Lofoten."}}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

201 CreatedJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4e",    "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"  }}

Erases every item of one content type in the bin

DELETE/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/trashKey required

Erases every item of one content type in the bin. Permission: content:purge.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • typestringquery, required

    The content type key to erase, such as trip. Required.

Responses

  • 200OK{ erased }.
    • dataobject

      Fields of data
      • erasedinteger

        How many items were erased.

  • 400Bad requestNo type.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:purge, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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 language, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/trash?type=trip' \  -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

200 OKJSON
{  "data": {    "erased": 1  }}

What is in the bin in this language

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/trashKey required

What is in the bin in this language. Permission: content:delete.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

Responses

  • 200OK[{ id, name, url, contentTypeKey, deletedAt, folderName, urlTaken, wasPublished }].
    • dataobject[]

      Fields of data
      • idstring

        An id.

      • namestring

      • urlstring or null

        The address it had.

      • contentTypeKeystring

      • deletedAtstring

      • folderNamestring or null

      • urlTakenboolean

        Another item now uses the address, so restoring gives it a new one.

      • wasPublishedboolean

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:delete.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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 language, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/trash' \  -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

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "url": "https://northwilds.com/trips/lofoten-sea-kayaking",      "contentTypeKey": "…",      "deletedAt": "2026-11-02T09:30:00.000Z",      "folderName": null,      "urlTaken": false,      "wasPublished": false    }  ]}

Moves it to the bin

DELETE/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}Key required

Moves it to the bin. redirectTo=/gear also adds a redirect from its live address. Permission: content:delete.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • redirectTostringquery

    Also add a redirect from its live address to this one, such as /trips.

Responses

  • 204No contentDone, nothing to return.
  • 400Bad requestA shared section that pages still use, or a redirect address that isn't valid.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:delete, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

One item with its draft

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}Key required

One item with its draft. Permission: content:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

Responses

  • 200OKThe item.
    • dataContent

      One piece of content with its draft.

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

      • statusstring

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

      • urlOverridestring or null

      • draftobject

        The draft. No seo for content without an address.

        Fields of draft
        • fieldsmap of any

          Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

        • componentsBlock[]

          Fields of Block

        • seoobjectsometimes

          Fields of seo
          • titlestring or null

          • descriptionstring or null

          • canonicalstring or null

          • noIndexboolean

          • ogTitlestring or null

          • ogDescriptionstring or null

          • ogImagestring or null

            A media id or address.

          • twitterTitlestring or null

          • twitterDescriptionstring or null

          • twitterImagestring or null

          • noFollowboolean

          • breadcrumbLabelstring or null

          • sitemapExcludeboolean

          • sitemapChangeFrequencystring or null

            One of always, hourly, daily, weekly, monthly, yearly, never.
          • sitemapPrioritynumber or null

            At least 0. At most 1.
        • updatedAtstring

        • updatedBystring

          An id.

      • draftVersioninteger

      • publishedVersioninteger

        Compare with draftVersion to see whether the draft has unpublished changes.

      • docVersioninteger

        Send it back with each save, so a save never overwrites changes you haven't seen.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21' \  -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

200 OKJSON
{  "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  }}

Saves the draft

PATCH/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}Key required

Saves the draft. Permission: content:update.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • dryRunstringquery

    true checks everything a save checks and answers the entry as it would be, without saving.

    One of true, false.
  • Idempotency-Keystringheader

    Optional. 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

  • namestringoptional

    Up to 200 characters.
  • slugstringoptional

  • urlOverridestring or nulloptional

    Up to 500 characters.
  • folderIdstring or nulloptional

    An id.

  • fieldsmap of anyoptional

    Field values by key. Fields you leave out keep their value.

  • componentsany[]optional

    Blocks: each { id, type, fields, children, variant }, where children holds slots of further blocks. See the Block schema.

  • seoobjectoptional

    Fields of seo
    • titlestring or nulloptional

      Up to 200 characters.
    • descriptionstring or nulloptional

      Up to 500 characters.
    • canonicalstring or nulloptional

      Up to 500 characters.
    • noIndexbooleanoptional

    • ogTitlestring or nulloptional

      Up to 200 characters.
    • ogDescriptionstring or nulloptional

      Up to 500 characters.
    • ogImagestring or nulloptional

      Up to 500 characters.
    • twitterTitlestring or nulloptional

      Up to 200 characters.
    • twitterDescriptionstring or nulloptional

      Up to 500 characters.
    • twitterImagestring or nulloptional

      Up to 500 characters.
    • noFollowbooleanoptional

    • breadcrumbLabelstring or nulloptional

      Up to 120 characters.
    • sitemapExcludebooleanoptional

    • sitemapChangeFrequencystring or nulloptional

      One of always, hourly, daily, weekly, monthly, yearly, never.
    • sitemapPrioritynumber or nulloptional

      At least 0. At most 1.
  • externalIdstring or nulloptional

    Your own id for the entry, or null to remove it. Unique in this language.

    Up to 200 characters.
  • isFolderIndexbooleanoptional

  • sortOrderintegeroptional

  • docVersionintegeroptional

    The version you read. A save answers 409 when the page has changed since.

Responses

  • 200OKThe item.
    • dataContent

      One piece of content with its draft.

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

      • statusstring

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

      • urlOverridestring or null

      • draftobject

        The draft. No seo for content without an address.

        Fields of draft
        • fieldsmap of any

          Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

        • componentsBlock[]

          Fields of Block

        • seoobjectsometimes

          Fields of seo
          • titlestring or null

          • descriptionstring or null

          • canonicalstring or null

          • noIndexboolean

          • ogTitlestring or null

          • ogDescriptionstring or null

          • ogImagestring or null

            A media id or address.

          • twitterTitlestring or null

          • twitterDescriptionstring or null

          • twitterImagestring or null

          • noFollowboolean

          • breadcrumbLabelstring or null

          • sitemapExcludeboolean

          • sitemapChangeFrequencystring or null

            One of always, hourly, daily, weekly, monthly, yearly, never.
          • sitemapPrioritynumber or null

            At least 0. At most 1.
        • updatedAtstring

        • updatedBystring

          An id.

      • draftVersioninteger

      • publishedVersioninteger

        Compare with draftVersion to see whether the draft has unpublished changes.

      • docVersioninteger

        Send it back with each save, so a save never overwrites changes you haven't seen.

  • 400Bad requestThe body isn't valid JSON. Or a field value breaks the content type's rules (each in details as { path, message }), the folder doesn't accept the content type, or a link points to a page in the bin or another space.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:update, or changes price, promotion or brand-locked fields without pricing:manage, promotions:manage or brand:manage.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

  • 409ConflictThe page changed since the docVersion you sent (details has currentVersion, expected and received), someone has it open, the address is taken, or the content type allows one item.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"docVersion":12,"fields":{"title":"Lofoten sea kayaking","days":6,"priceFrom":18900}}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "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  }}

What the Delivery API answers for it

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/deliveryKey required

What the Delivery API answers for it. draft=true for the draft. Permission: content:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • draftstringquery

    true for what the draft would deliver.

    One of true, false.

Responses

  • 200OK{ request, body }.
    • dataobject

      Fields of data
      • requeststring

        The Delivery API address that answers this, such as /cms/v1/content?url=/trips/lofoten-sea-kayaking.

      • bodyany

        What it answers: a Page or, for a global entry, a Global. See https://docs.bifrostorbit.com/reference/cms-delivery/.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/delivery' \  -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

200 OKJSON
{  "data": {    "request": "/cms/v1/content?url=/trips/lofoten-sea-kayaking",    "body": null  }}

What the Delivery API would answer for a draft you send in the body, before saving it

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/deliveryKey required

What the Delivery API would answer for a draft you send in the body, before saving it. as=banner or as=popup previews a banner or popup; include=references adds referenced entries. Permission: content:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • asstringquery

    banner or popup previews the draft as a banner or popup.

    One of banner, popup.
  • includestringquery

    references adds the entries the draft refers to.

  • Idempotency-Keystringheader

    Optional. 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

  • fieldsmap of anyrequired

    The draft's field values.

  • componentsBlock[]optional

    Fields of components
    • idstringrequired

    • typestringrequired

      The component's key, such as hero.

    • schemaVersionintegerrequired

    • fieldsmap of anyrequired

      The component's fields.

    • childrenmap of Block[]required

      Further blocks by slot.

      Fields of children
      • idstringrequired

      • typestringrequired

        The component's key, such as hero.

      • schemaVersionintegerrequired

      • fieldsmap of anyrequired

        The component's fields.

      • childrenmap of Block[]required

        Further blocks by slot.

        Fields of children
        • idstringrequired

        • typestringrequired

          The component's key, such as hero.

        • schemaVersionintegerrequired

        • fieldsmap of anyrequired

          The component's fields.

        • childrenmap of Block[]required

          Further blocks by slot.

          Fields of children
          • idstringrequired

          • typestringrequired

            The component's key, such as hero.

          • schemaVersionintegerrequired

          • fieldsmap of anyrequired

            The component's fields.

          • childrenmap of Block[]required

            Further blocks by slot.

          • variantstring or nullrequired

        • variantstring or nullrequired

      • variantstring or nullrequired

    • variantstring or nullrequired

Responses

  • 200OK{ request, body }.
    • dataany

      What the Delivery API would answer: { fields, components } for a page, or a banner or popup as the Delivery API delivers them. See https://docs.bifrostorbit.com/reference/cms-delivery/.

  • 400Bad requestThe body isn't valid JSON. Or the draft breaks the content type's rules, or as=banner on content that isn't a banner.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:read, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/delivery' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"fields":{"title":"Lofoten sea kayaking"},"components":[]}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": null}

Copies it in the same folder, with a new name and address

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/duplicateKey required

Copies it in the same folder, with a new name and address. includeMedia (default true). Permission: content:copy.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • Idempotency-Keystringheader

    Optional. 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

  • includeContentbooleanoptional

    Copy the fields and blocks.

    Default true.
  • includeSeobooleanoptional

    Copy the search settings.

    Default true.
  • includeMediabooleanoptional

    Keep the images and files.

    Default true.

Responses

  • 201CreatedThe summary.
    • dataContentSummary

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

        Such as /trips/lofoten-sea-kayaking. null for content without an address.

      • statusstring

        published once it has been published, even while the draft has changes.

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

        Your own id for the entry, such as its id in the system it was imported from. Unique in its language.

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

  • 400Bad requestThe body isn't valid JSON.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:copy, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/duplicate' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"includeMedia":true}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

201 CreatedJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a4e",    "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"  }}

A preview link for the draft, valid for an hour

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/previewKey required

A preview link for the draft, valid for an hour. Permission: content:read_draft.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • Idempotency-Keystringheader

    Optional. 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

  • 201Created{ token, expiresAt, url }.
    • dataobject

      Fields of data
      • tokenstring

      • expiresAtstring

        In an hour.

      • urlstring

        The space's preview address with the token, ready to open.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:read_draft, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/preview' \  -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

201 CreatedJSON
{  "data": {    "token": "cms_pk_…",    "expiresAt": "2026-11-02T09:30:00.000Z",    "url": "https://northwilds.com/trips/lofoten-sea-kayaking"  }}

Erases an item in the bin, with its history, for good

DELETE/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/purgeKey required

Erases an item in the bin, with its history, for good. Permission: content:purge.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

Responses

  • 204No contentDone, nothing to return.
  • 400Bad requestIt isn't in the bin.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:purge, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/purge' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Takes it out of the bin, as an unpublished draft

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/restoreKey required

Takes it out of the bin, as an unpublished draft. Permission: content:create.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • Idempotency-Keystringheader

    Optional. 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

  • 200OKThe item.
    • dataContent

      One piece of content with its draft.

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

      • statusstring

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

      • urlOverridestring or null

      • draftobject

        The draft. No seo for content without an address.

        Fields of draft
        • fieldsmap of any

          Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

        • componentsBlock[]

          Fields of Block

        • seoobjectsometimes

          Fields of seo
          • titlestring or null

          • descriptionstring or null

          • canonicalstring or null

          • noIndexboolean

          • ogTitlestring or null

          • ogDescriptionstring or null

          • ogImagestring or null

            A media id or address.

          • twitterTitlestring or null

          • twitterDescriptionstring or null

          • twitterImagestring or null

          • noFollowboolean

          • breadcrumbLabelstring or null

          • sitemapExcludeboolean

          • sitemapChangeFrequencystring or null

            One of always, hourly, daily, weekly, monthly, yearly, never.
          • sitemapPrioritynumber or null

            At least 0. At most 1.
        • updatedAtstring

        • updatedBystring

          An id.

      • draftVersioninteger

      • publishedVersioninteger

        Compare with draftVersion to see whether the draft has unpublished changes.

      • docVersioninteger

        Send it back with each save, so a save never overwrites changes you haven't seen.

  • 400Bad requestIt isn't in the bin, or its folder is gone.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:create, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/restore' \  -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

200 OKJSON
{  "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 saved and published versions, newest first, within the plan's history

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/revisionsKey required

Its saved and published versions, newest first, within the plan's history. Permission: content:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

Responses

  • 200OK[{ id, version, kind, changeSummary, rollbackOfVersion, userId, by, createdAt }].
    • dataobject[]

      Newest first, within the plan's history.

      Fields of data
      • idstring

        An id.

      • versioninteger

      • kindstring

        One of save, publish, unpublish, rollback, release, promotion.
      • changeSummarystring or null

      • rollbackOfVersioninteger or null

      • userIdstring

        An id.

      • bystring or null

        Who, by name.

      • createdAtstring

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/revisions' \  -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

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f40a40",      "version": 12,      "kind": "save",      "changeSummary": null,      "rollbackOfVersion": 12,      "userId": "6650f1c2a9e4b1d2c3f40a30",      "by": "Ingrid Berg",      "createdAt": "2026-11-02T09:30:00.000Z"    }  ]}

What changed between a revision and the draft

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/revisions/{revisionId}/compareKey required

What changed between a revision and the draft. Permission: content:read_draft.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

  • revisionIdstringpath, required

    The revision's id.

Responses

  • 200OK{ version, createdAt, changes, before }.
    • dataobject

      Fields of data
      • versioninteger

      • createdAtstring

      • changesobject[]

        What differs between the revision and the draft.

        Fields of changes
        • areastring

          One of field, seo, component.
        • keystring

        • typestringsometimes

        • changestring

          One of added, removed, changed.
        • fieldsstring[]sometimes

        • labelstring

          Such as Title, or Hero › Heading.

      • beforeobject

        The revision's fields and blocks.

        Fields of before
  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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:read_draft.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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 revision, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When 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.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/revisions/6650f1c2a9e4b1d2c3f40a30/compare' \  -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

200 OKJSON
{  "data": {    "version": 12,    "createdAt": "2026-11-02T09:30:00.000Z",    "changes": [      {        "area": "field",        "key": "lofoten",        "type": "…",        "change": "added",        "fields": [          "…"        ],        "label": "Kayaking"      }    ],    "before": {      "fields": {},      "components": [        {          "id": "hero-1",          "type": "hero",          "schemaVersion": 12,          "fields": {            "heading": "Paddle the Lofoten fjords"          },          "children": {},          "variant": null        }      ]    }  }}

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.

  • errorobject

    Fields of error
    • codestring

      One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
    • messagestring

      Follows Accept-Language when CMS Orbit has the language.

    • detailsanysometimes

      When 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.

  • idstring

  • typestring

    The component's key, such as hero.

  • schemaVersioninteger

  • fieldsmap of any

    The component's fields.

  • childrenmap of Block[]

    Further blocks by slot.

    Fields of children
    • idstring

    • typestring

      The component's key, such as hero.

    • schemaVersioninteger

    • fieldsmap of any

      The component's fields.

    • childrenmap of Block[]

      Further blocks by slot.

      Fields of children
      • idstring

      • typestring

        The component's key, such as hero.

      • schemaVersioninteger

      • fieldsmap of any

        The component's fields.

      • childrenmap of Block[]

        Further blocks by slot.

        Fields of children
        • idstring

        • typestring

          The component's key, such as hero.

        • schemaVersioninteger

        • fieldsmap of any

          The component's fields.

        • childrenmap of Block[]

          Further blocks by slot.

        • variantstring or null

      • variantstring or null

    • variantstring or null

  • variantstring or null

ContentSummary

  • idstring

    An id.

  • namestring

  • slugstring

  • urlstring or null

    Such as /trips/lofoten-sea-kayaking. null for content without an address.

  • statusstring

    published once it has been published, even while the draft has changes.

    One of draft, in_review, published, scheduled, archived.
  • contentTypeKeystring

  • folderIdstring or null

    An id.

  • externalIdstring or null

    Your own id for the entry, such as its id in the system it was imported from. Unique in its language.

  • isGlobalboolean

  • isFolderIndexboolean

  • updatedAtstring

  • publishedAtstring or null

Content

One piece of content with its draft.

  • idstring

    An id.

  • namestring

  • slugstring

  • urlstring or null

  • statusstring

    One of draft, in_review, published, scheduled, archived.
  • contentTypeKeystring

  • folderIdstring or null

    An id.

  • externalIdstring or null

  • isGlobalboolean

  • isFolderIndexboolean

  • updatedAtstring

  • publishedAtstring or null

  • urlOverridestring or null

  • draftobject

    The draft. No seo for content without an address.

    Fields of draft
    • fieldsmap of any

      Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

    • componentsBlock[]

      Fields of Block

    • seoobjectsometimes

      Fields of seo
      • titlestring or null

      • descriptionstring or null

      • canonicalstring or null

      • noIndexboolean

      • ogTitlestring or null

      • ogDescriptionstring or null

      • ogImagestring or null

        A media id or address.

      • twitterTitlestring or null

      • twitterDescriptionstring or null

      • twitterImagestring or null

      • noFollowboolean

      • breadcrumbLabelstring or null

      • sitemapExcludeboolean

      • sitemapChangeFrequencystring or null

        One of always, hourly, daily, weekly, monthly, yearly, never.
      • sitemapPrioritynumber or null

        At least 0. At most 1.
    • updatedAtstring

    • updatedBystring

      An id.

  • draftVersioninteger

  • publishedVersioninteger

    Compare with draftVersion to see whether the draft has unpublished changes.

  • docVersioninteger

    Send it back with each save, so a save never overwrites changes you haven't seen.