CMS Orbit management API
Change what is in CMS Orbit from scripts and integrations: pages, media, content types, menus, redirects, keys and settings.
The management API is how scripts and integrations change what is in CMS Orbit, with the same permissions as the screens. Send a management token (cms_mt_) as Authorization: Bearer. A token acts as the person who created it, works for one organisation and lasts 1 to 365 days; a read-only token gets 403 on every write.
Bodies are JSON with Content-Type: application/json, except uploads, which are multipart/form-data. PATCH changes only the fields you send; PUT replaces the whole setting. Answers are { data } with 200 or 201, or empty with 204. Lists return every item at once. Errors are { error: { code, message, details } }.
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.
Endpoints
- Organisation
4 endpoints
- Management tokens
5 endpoints
- Command-line sign-ins
2 endpoints
- Members and roles
10 endpoints
- Spaces
15 endpoints
- SEO and accessibility settings
6 endpoints
- Delivery keys
6 endpoints
- Connected satellites
24 endpoints
- Content types and components
14 endpoints
- Domains
8 endpoints
- Environments, regions and languages
12 endpoints
- Content
15 endpoints
- Publishing
8 endpoints
- POSTPublishes a banner at once on every page, past approval
- POSTCopies the published version to another environment and publishes it there
- POSTPromotes every published entry in a folder or language to another environment, with their redirects
- POSTPublishes the draft
- POSTPuts an earlier revision back
- GETIts scheduled publishing and unpublishing
- And 2 more
- Reviews
8 endpoints
- Copying and translating
5 endpoints
- POSTBrings a regional copy up to date with its source
- POSTCopies pages or folders to another region or language
- POSTMachine-translates text into this language
- GETA page or a folder's pages as an XLIFF 2.0 file for translation into another language of the region
- POSTImports a translated XLIFF file as drafts in the other language, making the pages there when they are missing
- Folders
6 endpoints
- Experiments
16 endpoints
- Feature flags
4 endpoints
- Media
19 endpoints
- Menus
4 endpoints
- Redirects
6 endpoints
- Releases
8 endpoints
- Taxonomies
11 endpoints
- Webhooks
6 endpoints