Skip to content

Spaces

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

Creates a website in one go: space, environments, regions and languages

POST/organisations/{organisationId}/setupKey required

Creates a website in one go: space, environments, regions and languages. Permission: space:create.

Parameters

  • organisationIdstringpath, required

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

  • 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

    Up to 80 characters.
  • templatestringoptional

    Default "business". Up to 40 characters.
  • environmentsstring[]required

    Any of staging and production.

  • regionsobject[]required

    Each region key must already exist in the organisation in Bifröst Orbit.

    Fields of regions
    • keystringrequired

    • languagesobject[]required

      Fields of languages
      • codestringrequired

        Up to 20 characters.
      • namestringrequired

        Up to 60 characters.
  • previewUrlstring or nulloptional

Responses

  • 201Created{ spaceId, environmentId }.
    • dataobject

      Fields of data
      • spaceIdstring

        An id.

      • environmentIdstring or null

        The first environment's id.

  • 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 space:create, or the plan's websites or environments are used up.
    • 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 organisation, 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, or a region key the organisation doesn't have.
    • 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/setup' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Northwilds","template":"business","environments":["staging","production"],"regions":[{"key":"norway","languages":[{"code":"nb-NO","name":"Norsk"},{"code":"en-GB","name":"English"}]}],"previewUrl":"https://northwilds.com/api/preview"}'

Try it

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

Example answer

201 CreatedJSON
{  "data": {    "spaceId": "6650f1c2a9e4b1d2c3f40a02",    "environmentId": "6650f1c2a9e4b1d2c3f40a13"  }}

The spaces the token reaches

GET/organisations/{organisationId}/spacesKey required

The spaces the token reaches. include=summary adds environments, counts and page totals. Permission: space:read.

Parameters

  • organisationIdstringpath, required

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

  • includestringquery

    summary adds environments, region and language counts, page totals and a snapshot of the website.

    Only summary.

Responses

  • 200OKList of spaces.
    • dataSpace or SpaceSummary[]

      Spaces, or with include=summary, SpaceSummary objects.

      Fields of data

      Spaces, or with include=summary, SpaceSummary objects.

  • 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 space: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 organisation, 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' \  -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",      "organisationId": "6650f1c2a9e4b1d2c3f40a01",      "name": "Lofoten sea kayaking",      "slug": "lofoten-sea-kayaking",      "description": "Six days of paddling between the peaks of Lofoten.",      "logoUrl": null,      "defaultEnvironmentId": null,      "settings": {        "autoRedirectOnUrlChange": true,        "localeFallbackEnabled": true,        "machineTranslation": true,        "previewUrl": null,        "previewUrls": [          {            "name": "Lofoten sea kayaking",            "url": "https://northwilds.com/trips/lofoten-sea-kayaking"          }        ],        "previewDevices": [          {            "name": "Lofoten sea kayaking",            "width": 1          }        ],        "timezone": "Europe/Oslo",        "regionFallback": null,        "trashRetentionDays": 30,        "seo": {          "xDefaultRegion": null,          "organisationName": null,          "socialProfiles": [            "…"          ],          "robotsTxt": null,          "titleTemplate": null,          "defaultDescription": null,          "defaultImage": null,          "twitterHandle": null,          "verification": {            "google": null,            "bing": null          },          "websitePaths": [            "…"          ],          "indexNow": false        },        "indexNowKey": "…",        "accessibility": {          "publish": "off",          "tags": [            "…"          ]        },        "insights": {          "site": "…",          "name": "Lofoten sea kayaking"        },        "workflowStages": [          {            "id": "6650f1c2a9e4b1d2c3f40a40",            "name": "Lofoten sea kayaking",            "colour": "…"          }        ],        "travel": {          "brandId": "6650f1c2a9e4b1d2c3f40a57",          "bookingSlug": "…",          "brandName": "Northwilds",          "siteUrl": "https://northwilds.com",          "connectedAt": "2026-11-02T09:30:00.000Z",          "connectedBy": "6650f1c2a9e4b1d2c3f40a30"        },        "commerce": {          "storeSlug": "…",          "brandName": "Northwilds",          "siteUrl": "https://northwilds.com",          "connectedAt": "2026-11-02T09:30:00.000Z",          "connectedBy": "6650f1c2a9e4b1d2c3f40a30"        },        "booking": {          "locationId": "6650f1c2a9e4b1d2c3f40a5a",          "slug": "lofoten-sea-kayaking",          "locationName": "…",          "siteUrl": "https://northwilds.com",          "connectedAt": "2026-11-02T09:30:00.000Z",          "connectedBy": "6650f1c2a9e4b1d2c3f40a30"        },        "presenceOrbit": {          "siteSlug": "…",          "brandName": "Northwilds",          "connectedAt": "2026-11-02T09:30:00.000Z",          "connectedBy": "6650f1c2a9e4b1d2c3f40a30"        },        "careers": {          "siteSlug": "…",          "name": "Lofoten sea kayaking",          "siteUrl": "https://northwilds.com",          "connectedAt": "2026-11-02T09:30:00.000Z",          "connectedBy": "6650f1c2a9e4b1d2c3f40a30"        },        "experiments": {          "assignment": "cookieless"        }      },      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    }  ]}

Creates a space

POST/organisations/{organisationId}/spacesKey required

Creates a space. Permission: space:create.

Parameters

  • organisationIdstringpath, required

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

  • 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 website's name, such as Northwilds.

    Up to 200 characters.
  • templatestringoptional

    One of business, blog, landing, shop, travel, local, careers, help or blank. Each adds a content model with sample pages; blank adds only the Page type.

  • slugstringoptional

  • descriptionstring or nulloptional

    Up to 2000 characters.
  • settingsobjectoptional

    Fields of settings
    • autoRedirectOnUrlChangebooleanoptional

      Default true.
    • localeFallbackEnabledbooleanoptional

      Default true.
    • machineTranslationbooleanoptional

      Default true.
    • previewUrlstring or nulloptional

      Default null.
    • previewUrlsobject[]optional

      Default []. Up to 10 items.
      Fields of previewUrls
      • namestringrequired

        Up to 60 characters.
      • urlstringrequired

    • previewDevicesobject[]optional

      Default []. Up to 6 items.
      Fields of previewDevices
      • namestringrequired

        Up to 30 characters.
      • widthintegerrequired

        At least 240. At most 3840.
    • timezonestringoptional

      Default "UTC".
    • regionFallbackstring or nulloptional

      Default null. Up to 60 characters.
    • trashRetentionDaysnumber or nulloptional

      One of 30, 60, 90. Default null.
  • environmentsobject[]optional

    Defaults to Staging and Production. Production is protected.

    Fields of environments
    • keystringrequired

    • namestringrequired

      Up to 200 characters.
    • kindstringoptional

      One of staging, production, custom. Default "custom".

Responses

  • 201CreatedThe space and its environments.
    • dataobject

      The space, with its environments.

      Fields of data
      • idstring

        An id.

      • organisationIdstring

        An id.

      • namestring

      • slugstring

      • descriptionstring or null

      • logoUrlstring or null

      • defaultEnvironmentIdstring or null

        An id.

      • settingsSpaceSettings

        Fields of SpaceSettings

      • createdAtstring

      • updatedAtstring

      • environmentsEnvironment[]

        Fields of Environment

  • 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 space:create, or the plan's websites are used up.
    • 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 organisation, 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.

  • 409ConflictA space with the slug 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' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Northwilds","description":"Trips and gear for the far north.","settings":{"timezone":"Europe/Oslo"}}'

Try it

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

Example answer

201 CreatedJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a40",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "name": "Lofoten sea kayaking",    "slug": "lofoten-sea-kayaking",    "description": "Six days of paddling between the peaks of Lofoten.",    "logoUrl": null,    "defaultEnvironmentId": null,    "settings": {      "autoRedirectOnUrlChange": true,      "localeFallbackEnabled": true,      "machineTranslation": true,      "previewUrl": null,      "previewUrls": [        {          "name": "Lofoten sea kayaking",          "url": "https://northwilds.com/trips/lofoten-sea-kayaking"        }      ],      "previewDevices": [        {          "name": "Lofoten sea kayaking",          "width": 1        }      ],      "timezone": "Europe/Oslo",      "regionFallback": null,      "trashRetentionDays": 30,      "seo": {        "xDefaultRegion": null,        "organisationName": null,        "socialProfiles": [          "…"        ],        "robotsTxt": null,        "titleTemplate": null,        "defaultDescription": null,        "defaultImage": null,        "twitterHandle": null,        "verification": {          "google": null,          "bing": null        },        "websitePaths": [          "…"        ],        "indexNow": false      },      "indexNowKey": "…",      "accessibility": {        "publish": "off",        "tags": [          "…"        ]      },      "insights": {        "site": "…",        "name": "Lofoten sea kayaking"      },      "workflowStages": [        {          "id": "6650f1c2a9e4b1d2c3f40a40",          "name": "Lofoten sea kayaking",          "colour": "…"        }      ],      "travel": {        "brandId": "6650f1c2a9e4b1d2c3f40a57",        "bookingSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "commerce": {        "storeSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "booking": {        "locationId": "6650f1c2a9e4b1d2c3f40a5a",        "slug": "lofoten-sea-kayaking",        "locationName": "…",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "presenceOrbit": {        "siteSlug": "…",        "brandName": "Northwilds",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "careers": {        "siteSlug": "…",        "name": "Lofoten sea kayaking",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "experiments": {        "assignment": "cookieless"      }    },    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z",    "environments": [      {        "id": "6650f1c2a9e4b1d2c3f40a13",        "spaceId": "6650f1c2a9e4b1d2c3f40a02",        "key": "production",        "name": "Production",        "kind": "production",        "isDefault": true,        "protected": false,        "sortOrder": 1      }    ]  }}

Moves the space to the bin

DELETE/organisations/{organisationId}/spaces/{spaceId}Key required

Moves the space to the bin. Permission: space:delete.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 204No contentDone, nothing to return.
  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • 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 space: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 space, 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' \  -H 'Authorization: Bearer cms_mt_…'

Try it

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

One space

GET/organisations/{organisationId}/spaces/{spaceId}Key required

One space. Permission: space:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKThe space.
    • dataSpace

      Fields of data
      • idstring

        An id.

      • organisationIdstring

        An id.

      • namestring

      • slugstring

      • descriptionstring or null

      • logoUrlstring or null

      • defaultEnvironmentIdstring or null

        An id.

      • settingsSpaceSettings

        Fields of SpaceSettings

      • createdAtstring

      • updatedAtstring

  • 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 space: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 space, 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' \  -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": "6650f1c2a9e4b1d2c3f40a02",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "name": "Northwilds website",    "slug": "northwilds-website",    "description": "Trips and gear for the far north.",    "logoUrl": null,    "defaultEnvironmentId": null,    "settings": {      "autoRedirectOnUrlChange": true,      "localeFallbackEnabled": true,      "machineTranslation": true,      "previewUrl": null,      "previewUrls": [        {          "name": "Lofoten sea kayaking",          "url": "https://northwilds.com/trips/lofoten-sea-kayaking"        }      ],      "previewDevices": [        {          "name": "Lofoten sea kayaking",          "width": 1        }      ],      "timezone": "Europe/Oslo",      "regionFallback": null,      "trashRetentionDays": 30,      "seo": {        "xDefaultRegion": null,        "organisationName": null,        "socialProfiles": [          "…"        ],        "robotsTxt": null,        "titleTemplate": null,        "defaultDescription": null,        "defaultImage": null,        "twitterHandle": null,        "verification": {          "google": null,          "bing": null        },        "websitePaths": [          "…"        ],        "indexNow": false      },      "indexNowKey": "…",      "accessibility": {        "publish": "off",        "tags": [          "…"        ]      },      "insights": {        "site": "…",        "name": "Lofoten sea kayaking"      },      "workflowStages": [        {          "id": "6650f1c2a9e4b1d2c3f40a40",          "name": "Lofoten sea kayaking",          "colour": "…"        }      ],      "travel": {        "brandId": "6650f1c2a9e4b1d2c3f40a57",        "bookingSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "commerce": {        "storeSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "booking": {        "locationId": "6650f1c2a9e4b1d2c3f40a5a",        "slug": "lofoten-sea-kayaking",        "locationName": "…",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "presenceOrbit": {        "siteSlug": "…",        "brandName": "Northwilds",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "careers": {        "siteSlug": "…",        "name": "Lofoten sea kayaking",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "experiments": {        "assignment": "cookieless"      }    },    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Changes its name, description, default environment or settings

PATCH/organisations/{organisationId}/spaces/{spaceId}Key required

Changes its name, description, default environment or settings. Permission: space:update.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space'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

  • namestringoptional

    Up to 200 characters.
  • descriptionstring or nulloptional

    Up to 2000 characters.
  • defaultEnvironmentIdstring or nulloptional

    An id.

  • settingsobjectoptional

    Merged into the existing settings.

    Fields of settings
    • autoRedirectOnUrlChangebooleanoptional

    • localeFallbackEnabledbooleanoptional

    • machineTranslationbooleanoptional

    • previewUrlstring or nulloptional

    • previewUrlsobject[]optional

      Up to 10 items.
      Fields of previewUrls
      • namestringrequired

        Up to 60 characters.
      • urlstringrequired

    • previewDevicesobject[]optional

      Up to 6 items.
      Fields of previewDevices
      • namestringrequired

        Up to 30 characters.
      • widthintegerrequired

        At least 240. At most 3840.
    • timezonestringoptional

    • regionFallbackstring or nulloptional

      Up to 60 characters.
    • trashRetentionDaysnumber or nulloptional

      One of 30, 60, 90.
    • workflowStagesobject[]optional

      Up to 12 items.
      Fields of workflowStages
      • idstringrequired

      • namestringrequired

        Up to 40 characters.
      • colourstringrequired

Responses

  • 200OKThe space.
    • dataSpace

      Fields of data
      • idstring

        An id.

      • organisationIdstring

        An id.

      • namestring

      • slugstring

      • descriptionstring or null

      • logoUrlstring or null

      • defaultEnvironmentIdstring or null

        An id.

      • settingsSpaceSettings

        Fields of SpaceSettings

      • createdAtstring

      • updatedAtstring

  • 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 space:update, 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 space, 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 PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"description":"Trips and gear for the far north.","settings":{"timezone":"Europe/Oslo","previewUrl":"https://northwilds.com/api/preview"}}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a02",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "name": "Northwilds website",    "slug": "northwilds-website",    "description": "Trips and gear for the far north.",    "logoUrl": null,    "defaultEnvironmentId": null,    "settings": {      "autoRedirectOnUrlChange": true,      "localeFallbackEnabled": true,      "machineTranslation": true,      "previewUrl": null,      "previewUrls": [        {          "name": "Lofoten sea kayaking",          "url": "https://northwilds.com/trips/lofoten-sea-kayaking"        }      ],      "previewDevices": [        {          "name": "Lofoten sea kayaking",          "width": 1        }      ],      "timezone": "Europe/Oslo",      "regionFallback": null,      "trashRetentionDays": 30,      "seo": {        "xDefaultRegion": null,        "organisationName": null,        "socialProfiles": [          "…"        ],        "robotsTxt": null,        "titleTemplate": null,        "defaultDescription": null,        "defaultImage": null,        "twitterHandle": null,        "verification": {          "google": null,          "bing": null        },        "websitePaths": [          "…"        ],        "indexNow": false      },      "indexNowKey": "…",      "accessibility": {        "publish": "off",        "tags": [          "…"        ]      },      "insights": {        "site": "…",        "name": "Lofoten sea kayaking"      },      "workflowStages": [        {          "id": "6650f1c2a9e4b1d2c3f40a40",          "name": "Lofoten sea kayaking",          "colour": "…"        }      ],      "travel": {        "brandId": "6650f1c2a9e4b1d2c3f40a57",        "bookingSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "commerce": {        "storeSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "booking": {        "locationId": "6650f1c2a9e4b1d2c3f40a5a",        "slug": "lofoten-sea-kayaking",        "locationName": "…",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "presenceOrbit": {        "siteSlug": "…",        "brandName": "Northwilds",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "careers": {        "siteSlug": "…",        "name": "Lofoten sea kayaking",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "experiments": {        "assignment": "cookieless"      }    },    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Copies a space

POST/organisations/{organisationId}/spaces/{spaceId}/cloneKey required

Copies a space. Permission: space:clone.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space'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

  • namestringrequired

    The copy's name. Required.

  • schemabooleanoptional

    Copy content types, components and taxonomies. Default true.

  • structurebooleanoptional

    Copy regions and languages. Default true.

  • contentbooleanoptional

    Copy pages, as drafts. Default false.

Responses

  • 201CreatedWhat was copied.
    • dataobject

      Fields of data
      • spaceIdstring

        The new space's id.

      • namestring

      • copiedmap of integer

        How many of each were copied, such as contentTypes and content.

  • 400Bad requestThe body isn't valid JSON. Or no name.
    • 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 space:clone, or the plan's websites are used up.
    • 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 space, 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/clone' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Northwilds winter campaign","content":true}'

Try it

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

Example answer

201 CreatedJSON
{  "data": {    "spaceId": "6650f1c2a9e4b1d2c3f40a02",    "name": "Lofoten sea kayaking",    "copied": {}  }}

Downloads the space as JSON

GET/organisations/{organisationId}/spaces/{spaceId}/exportKey required

Downloads the space as JSON. Permission: space:clone.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKAn attachment, named after the space and the day.
    • format"cms-orbit-export"

    • version1

    • exportedAtstring

    • spacemap of any

      The space's name, slug and settings.

    • collectionsmap of any[]

      Every environment, region, language, content type, component, taxonomy, term, folder, page, menu, redirect, domain, media folder and file.

  • 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 space:clone.
    • 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 space, 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/export' \  -H 'Authorization: Bearer cms_mt_…'

Try it

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

Adds content types, components and taxonomies from an export

POST/organisations/{organisationId}/spaces/{spaceId}/importKey required

Adds content types, components and taxonomies from an export. Permission: schema:manage.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space'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

  • fileanyrequired

    The export, as GET {space}/export answers it.

  • applybooleanoptional

    false (the default) only reports what would happen. true does it.

Responses

  • 200OKWhat was or would be added.
    • dataobject

      Fields of data
      • appliedboolean

      • itemsobject[]

        Items that exist are skipped, never overwritten.

        Fields of items
        • kindstring

          One of contentType, component, taxonomy.
        • keystring

        • namestring

        • outcomestring

          One of add, exists, error.
        • messagestring or null

  • 400Bad requestThe body isn't valid JSON. Or file isn't a CMS Orbit export.
    • 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 schema:manage, 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 space, 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/import' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"file":{"format":"cms-orbit-export","version":1},"apply":false}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "applied": false,    "items": [      {        "kind": "contentType",        "key": "lofoten",        "name": "Lofoten sea kayaking",        "outcome": "add",        "message": null      }    ]  }}

Adds pages from an export

POST/organisations/{organisationId}/spaces/{spaceId}/import/contentKey required

Adds pages from an export. Permission: space:clone.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space'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

  • fileanyrequired

    The export, as GET {space}/export answers it.

  • applybooleanoptional

    false (the default) only reports what would happen. true does it.

Responses

  • 200OKWhat was or would be added.
    • dataobject

      Fields of data
      • appliedboolean

      • itemsobject[]

        Pages are matched by environment key, region key and language code.

        Fields of items
        • namestring

        • urlstring or null

        • wherestring

          The environment, region and language it goes to.

        • outcomestring

          One of add, exists, error.
        • messagestring or null

  • 400Bad requestThe body isn't valid JSON. Or file isn't a CMS Orbit export.
    • 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 space:clone, 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 space, 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/import/content' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"file":{"format":"cms-orbit-export","version":1},"apply":true}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "applied": false,    "items": [      {        "name": "Lofoten sea kayaking",        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "where": "…",        "outcome": "add",        "message": null      }    ]  }}

Spaces in the bin

GET/organisations/{organisationId}/trash/spacesKey required

Spaces in the bin. Permission: space:delete.

Parameters

  • organisationIdstringpath, required

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

Responses

  • 200OKList.
    • dataobject[]

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • logoUrlstring or null

      • deletedAtstring

      • deletedBystring or null

        Who moved it to the bin.

  • 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 space: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 organisation, 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/trash/spaces' \  -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",      "slug": "lofoten-sea-kayaking",      "logoUrl": null,      "deletedAt": "2026-11-02T09:30:00.000Z",      "deletedBy": "6650f1c2a9e4b1d2c3f40a30"    }  ]}

Erases a space in the bin, with its content and media, for good

DELETE/organisations/{organisationId}/trash/spaces/{trashedSpaceId}Key required

Erases a space in the bin, with its content and media, for good. Permission: space:purge (owners).

Parameters

  • organisationIdstringpath, required

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

  • trashedSpaceIdstringpath, required

    The id of the space in the bin.

Responses

  • 200OKWhat was erased.
    • dataobject

      Fields of data
      • namestring

      • slugstring

      • documentsmap of integer

        How many of each were erased.

      • objectsRemovedinteger

        Files removed from storage.

  • 400Bad requestThe space 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 space:purge, which only owners have.
    • 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 space in the bin, 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/trash/spaces/6650f1c2a9e4b1d2c3f40a02' \  -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": {    "name": "Lofoten sea kayaking",    "slug": "lofoten-sea-kayaking",    "documents": {},    "objectsRemoved": 1  }}

Takes a space out of the bin

POST/organisations/{organisationId}/trash/spaces/{trashedSpaceId}Key required

Takes a space out of the bin. Permission: space:delete.

Parameters

  • organisationIdstringpath, required

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

  • trashedSpaceIdstringpath, required

    The id of the space in the bin.

  • 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 space.
    • dataSpace

      Fields of data
      • idstring

        An id.

      • organisationIdstring

        An id.

      • namestring

      • slugstring

      • descriptionstring or null

      • logoUrlstring or null

      • defaultEnvironmentIdstring or null

        An id.

      • settingsSpaceSettings

        Fields of SpaceSettings

      • createdAtstring

      • updatedAtstring

  • 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 space:delete, or the plan's websites are used up.
    • 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 space in the bin, 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/trash/spaces/6650f1c2a9e4b1d2c3f40a02' \  -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": "6650f1c2a9e4b1d2c3f40a02",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "name": "Northwilds website",    "slug": "northwilds-website",    "description": "Trips and gear for the far north.",    "logoUrl": null,    "defaultEnvironmentId": null,    "settings": {      "autoRedirectOnUrlChange": true,      "localeFallbackEnabled": true,      "machineTranslation": true,      "previewUrl": null,      "previewUrls": [        {          "name": "Lofoten sea kayaking",          "url": "https://northwilds.com/trips/lofoten-sea-kayaking"        }      ],      "previewDevices": [        {          "name": "Lofoten sea kayaking",          "width": 1        }      ],      "timezone": "Europe/Oslo",      "regionFallback": null,      "trashRetentionDays": 30,      "seo": {        "xDefaultRegion": null,        "organisationName": null,        "socialProfiles": [          "…"        ],        "robotsTxt": null,        "titleTemplate": null,        "defaultDescription": null,        "defaultImage": null,        "twitterHandle": null,        "verification": {          "google": null,          "bing": null        },        "websitePaths": [          "…"        ],        "indexNow": false      },      "indexNowKey": "…",      "accessibility": {        "publish": "off",        "tags": [          "…"        ]      },      "insights": {        "site": "…",        "name": "Lofoten sea kayaking"      },      "workflowStages": [        {          "id": "6650f1c2a9e4b1d2c3f40a40",          "name": "Lofoten sea kayaking",          "colour": "…"        }      ],      "travel": {        "brandId": "6650f1c2a9e4b1d2c3f40a57",        "bookingSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "commerce": {        "storeSlug": "…",        "brandName": "Northwilds",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "booking": {        "locationId": "6650f1c2a9e4b1d2c3f40a5a",        "slug": "lofoten-sea-kayaking",        "locationName": "…",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "presenceOrbit": {        "siteSlug": "…",        "brandName": "Northwilds",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "careers": {        "siteSlug": "…",        "name": "Lofoten sea kayaking",        "siteUrl": "https://northwilds.com",        "connectedAt": "2026-11-02T09:30:00.000Z",        "connectedBy": "6650f1c2a9e4b1d2c3f40a30"      },      "experiments": {        "assignment": "cookieless"      }    },    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

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.

SpaceSettings

  • autoRedirectOnUrlChangeboolean

    Add a redirect when a published page's address changes.

  • localeFallbackEnabledboolean

  • machineTranslationbooleansometimes

  • previewUrlstring or null

  • previewUrlsobject[]sometimes

    Fields of previewUrls
    • namestring

    • urlstring

  • previewDevicesobject[]sometimes

    Fields of previewDevices
    • namestring

    • widthinteger

  • timezonestring

    An IANA zone, such as Europe/Oslo.

  • regionFallbackstring or nullsometimes

    A region key.

  • trashRetentionDaysinteger or nullsometimes

    One of 30, 60, 90.
  • seoSiteSeosometimes

    Fields of SiteSeo

  • indexNowKeystringsometimes

    The key search engines check at /<key>.txt on the website before accepting IndexNow pings. Made the first time one is sent.

  • accessibilityAccessibilitySettingssometimes

    Fields of AccessibilitySettings

  • insightsobjectsometimes

    Fields of insights
    • sitestring

    • namestring

  • workflowStagesobject[]sometimes

    Fields of workflowStages
    • idstring

    • namestring

    • colourstring

      Such as #2f6f4f.

  • travelobjectsometimes

    Fields of travel
    • brandIdstringsometimes

    • bookingSlugstring

    • brandNamestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • commerceobjectsometimes

    Fields of commerce
    • storeSlugstring

    • brandNamestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • bookingobjectsometimes

    Fields of booking
    • locationIdstring

    • slugstring

    • locationNamestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • presenceOrbitobjectsometimes

    Fields of presenceOrbit
    • siteSlugstring

    • brandNamestring

    • connectedAtstring

    • connectedBystring or null

  • careersobjectsometimes

    Fields of careers
    • siteSlugstring

    • namestring

    • siteUrlstring

    • connectedAtstring

    • connectedBystring or null

  • experimentsobjectsometimes

    Fields of experiments
    • assignmentstring

      One of cookieless, consent, cookie.

Space

  • idstring

    An id.

  • organisationIdstring

    An id.

  • namestring

  • slugstring

  • descriptionstring or null

  • logoUrlstring or null

  • defaultEnvironmentIdstring or null

    An id.

  • settingsSpaceSettings

    Fields of SpaceSettings

  • createdAtstring

  • updatedAtstring

Environment

  • idstring

    An id.

  • spaceIdstring

    An id.

  • keystring

    Such as production. Never changes.

  • namestring

  • kindstring

    One of staging, production, custom.
  • isDefaultboolean

  • protectedboolean

    A protected environment can't be deleted.

  • sortOrderinteger

AccessibilitySettings

  • publishstring

    Whether accessibility problems warn or block publishing.

    One of off, warn, block.
  • tagsstring[]

    The rule sets that apply.

SiteSeo

  • xDefaultRegionstring or null

  • organisationNamestring or null

  • socialProfilesstring[]

  • robotsTxtstring or null

  • titleTemplatestring or nullsometimes

    Such as %s | Northwilds.

  • defaultDescriptionstring or nullsometimes

  • defaultImagestring or nullsometimes

    A media id.

  • twitterHandlestring or nullsometimes

  • verificationobjectsometimes

    Fields of verification
    • googlestring or nullsometimes

    • bingstring or nullsometimes

  • websitePathsstring[]sometimes

  • indexNowbooleansometimes

    Tells search engines through IndexNow when a page is published, unpublished, moved or deleted in an environment they may index. On unless switched off.

SpaceSummary

  • idstring

    An id.

  • namestring

  • slugstring

  • descriptionstring or null

  • logoUrlstring or null

  • environmentsobject[]

    Fields of environments
    • idstring

      An id.

    • namestring

    • keystring

    • kindstring

  • regionCountinteger

  • localeCountinteger

  • updatedAtstring

  • snapshotUrlstring or null

    A screenshot of the website's home page.

  • pagesobject

    Fields of pages
    • liveinteger

    • changedinteger

      Published pages with unpublished changes.