Skip to content
CM Box Documentation
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
User Guide
Overview
Getting started
Signing in and the Dashboard
Finding your way around
Working with content
Browse content
Create and upload content
Update existing content
Drafts, versions, and publishing
Archive and delete content
Finding content
Search for content
Filter the content list
Organize and find content with categories
Assets and media
Renditions and previews
Sites
Edit site pages
Update packages
Update packages
Workflow
Submit content to workflow
Handle a rejection and resubmit
Set your preferences
Administration
Overview
Installation
Deployment
Instance setup
Configuration
Environment variable reference
Storage backends
Content repositories
Content modeling
Security
Set up webhooks and workflow
Background queues
Upgrade CM Box
Configure integrations
Developer
Overview
Architecture overview
Authentication
REST API
GraphQL API
Content model
Permissions reference
Webhooks and workflow integration
Building integrations
REST API Reference
Overview
Authentication
Overview
Exchange client credentials for access token
Items
Overview
Items root (informational)
Create a new content item
Get item by ID
Update an item
Get item by ID and version
Get item by slug
Delete an item version
Check slug (informational)
Check if a slug exists
Copy item (informational)
Copy an item
Get item from package
Update an item in a package
Get item from package by slug
Get item version from package
Delete an item version from a package
Sync items root (informational)
Create an item (sync mode)
Upload test (informational)
Test a resumable upload
Resumable upload (TUS protocol)
Get latest published item by ID
Get latest published item by slug
Content Management
Overview
List content types
Create a content type
Get content type by ID
Update a content type
Delete a content type
Lock a content type
Lock a content type
Unlock a content type
Unlock a content type
List taxonomies
Create a taxonomy
Get taxonomy by ID
Update a taxonomy
Delete a taxonomy
List categories
Create a category
Get category by ID
Update a category
Delete a category
List update packages
List packages for repository
Create an update package
Get update package
Update an update package
Delete an update package
Preview a package merge
Merge an update package
List items in package
Add items to a package (alias)
Add items to a package
Remove items from a package
List all folders
Get folder by ID
Update a folder
Delete a folder
Create a folder
List repositories
Create a repository
Get repository by ID
Update a repository
Delete a repository
Get a category
List field types
List reserved field names
Check auto-package rules
Create and save an item inside a package
Generate a page diff
View a generated page diff
Update a package from the base repository
Update rendition filenames
Assets
Overview
Get asset by ID
Get asset metadata by ID
Get asset by slug
Get asset metadata by slug
Get package-scoped asset by ID
Get package-scoped asset by slug
Zip multiple assets
Zip multiple package-scoped assets
Published Assets
Overview
Get published asset by ID
Get published asset metadata by ID
Get published asset by slug
Get published asset metadata by slug
Security
Overview
List users
Get user by ID
Update a user
Create a user
Delete a user
List groups
Get group by ID
Update a group
Create a group
Delete a group
List roles
Get role by ID
Update a role
Create a role
Delete a role
List service accounts
Create a service account
Get service account by ID
Update a service account
Delete a service account
List permission bundles
Create a permission bundle
Get permission bundle by ID
Update a permission bundle
Delete a permission bundle
Get group relationship info
Get role relationship info
Get service account relationship info
Get user relationship info
Get effective permissions
Sync users from directory
Update a security entity relationship
Update user preferences
Queue
Overview
List queues
List jobs in queue
Clean jobs from queue
Get job by ID
Delete job by ID
Admin
Overview
List all configurations
Create a configuration
Get configuration by ID
Update a configuration
Delete a configuration
List webhooks
Get webhook by ID or name
Update a webhook
Create a webhook
Delete a webhook
List search indexes
Get index information
Create access configuration with generated key
Get access configuration
Create access configuration with explicit ID
Get a stored file
Write a stored file
Get system settings
Update system settings
Trigger a repository process
List OCM repositories
Get an OCM repository
Get an OCM publish channel
Sites
Overview
List sites
Create a site
Get site by ID
Update a site
Delete a site
Get assets to publish
Publish site assets
Get packages for site
Get site data for package
Update site info for package
Activity
Overview
Get asset activity and version history
Get package asset activity and version history
Dependencies
Overview
Get asset dependencies
Get package asset dependencies
References
Overview
Get asset references
Get site references for an asset
Get package asset references
Get package asset site references
Renditions
Overview
Get asset renditions
Update a rendition
Create a new rendition
Regenerate renditions
Delete a rendition
Get package asset renditions
Update a rendition in a package
Create a rendition in a package
Regenerate package asset renditions
Delete a rendition from a package
Queries
Overview
Get GraphQL query for a content type
User
Overview
Get current authentication token
Get integration token
Update user preferences
Partially update user preferences
Workflow
Overview
Trigger workflow event
Workflow status callback
Get package workflow info
AI
Overview
Clean up an image
Proxy a GET request to the AI service
Proxy a POST request to the AI service
GraphQL
Overview
Proxy a GraphQL GET request
Proxy a GraphQL query or mutation
GraphQL CORS preflight
Integration
Overview
Integration GET passthrough
Integration PUT passthrough
Integration POST passthrough
Workflow Admin
List all workflow connections
Create workflow connection
Get workflow connection
Update workflow connection
Delete workflow connection
List all workflow definitions
Create workflow definition
Get workflow definition
Update workflow definition
Delete workflow definition
Select theme
Dark
Light
Auto
Overview
Content Management
Section titled “Content Management”
Content types, taxonomies, folders, and repositories
Operations
Section titled “Operations”
GET
/api/content/management/types
POST
/api/content/management/types
GET
/api/content/management/types/{id}
PUT
/api/content/management/types/{id}
DELETE
/api/content/management/types/{id}
PUT
/api/content/management/types/{id}/lock
POST
/api/content/management/types/{id}/lock
PUT
/api/content/management/types/{id}/unlock
POST
/api/content/management/types/{id}/unlock
GET
/api/content/management/taxonomies
POST
/api/content/management/taxonomies
GET
/api/content/management/taxonomies/{id}
PUT
/api/content/management/taxonomies/{id}
DELETE
/api/content/management/taxonomies/{id}
GET
/api/content/management/categories
POST
/api/content/management/categories
GET
/api/content/management/categories/{id}
PUT
/api/content/management/categories/{id}
DELETE
/api/content/management/categories/{id}
GET
/api/content/management/packages
GET
/api/content/management/packages/{repo}
POST
/api/content/management/packages/{repo}
GET
/api/content/management/packages/{repo}/{packageName}
PUT
/api/content/management/packages/{repo}/{packageName}
DELETE
/api/content/management/packages/{repo}/{packageName}
GET
/api/content/management/packages/{repo}/{packageName}/merge
POST
/api/content/management/packages/{repo}/{packageName}/merge
GET
/api/content/management/packages/{repo}/{packageName}/items
PUT
/api/content/management/packages/{repo}/{packageName}/items
POST
/api/content/management/packages/{repo}/{packageName}/items
DELETE
/api/content/management/packages/{repo}/{packageName}/items
GET
/api/content/management/folders/{configId}/all
GET
/api/content/management/folders/{configId}/{folderId}
PUT
/api/content/management/folders/{configId}/{folderId}
DELETE
/api/content/management/folders/{configId}/{folderId}
POST
/api/content/management/folders/{configId}
GET
/api/content/management/repositories
POST
/api/content/management/repositories
GET
/api/content/management/repositories/{id}
PUT
/api/content/management/repositories/{id}
DELETE
/api/content/management/repositories/{id}
GET
/api/content/management/category/{id}
GET
/api/content/management/types/fields
GET
/api/content/management/types/fields/reserved
POST
/api/content/management/packages/auto-package/check
POST
/api/content/management/packages/auto-package/create-and-save
POST
/api/content/management/packages/{repo}/{packageName}/page-diff
GET
/api/content/management/packages/{repo}/{packageName}/page-diff/{diffKey}
POST
/api/content/management/packages/{repo}/{packageName}/update-from-base
GET
/api/content/management/util/updateRenditionsFilename/{id}