Skip to content
CM Box Documentation

Overview

CM Box API 1.0.0

Section titled “CM Box API 1.0.0”

API documentation for the Fishbowl CM Box content management platform

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/oauth2/token
GET
/api/items
POST
/api/items
GET
/api/items/{configId}/{itemId}
PUT
/api/items/{configId}/{itemId}
GET
/api/items/{configId}/{itemId}/version/{version}
GET
/api/items/{configId}/slug/{slug}
DELETE
/api/items/{configId}/{itemId}/{version}
GET
/api/items/checkSlug
POST
/api/items/checkSlug
GET
/api/items/copy
POST
/api/items/copy
GET
/api/items/{configId}/_package/{packageName}/{itemId}
PUT
/api/items/{configId}/_package/{packageName}/{itemId}
GET
/api/items/{configId}/_package/{packageName}/slug/{slug}
GET
/api/items/{configId}/_package/{packageName}/{itemId}/version/{version}
DELETE
/api/items/{configId}/_package/{packageName}/{itemId}/{version}
GET
/api/items/sync
POST
/api/items/sync
GET
/api/items/upload/test
POST
/api/items/upload/test
POST
/api/items/upload
GET
/api/items/published/{config_id}/{asset_id}
GET
/api/items/published/{config_id}/slug/{item_slug}
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}
GET
/api/assets/{configId}/{assetId}/{rendition}
HEAD
/api/assets/{configId}/{assetId}/{rendition}
GET
/api/assets/{configId}/slug/{slug}/{rendition}
HEAD
/api/assets/{configId}/slug/{slug}/{rendition}
GET
/api/assets/{configId}/_package/{packageName}/{assetId}/{rendition}
GET
/api/assets/{configId}/_package/{packageName}/slug/{slug}/{rendition}
POST
/api/assets/zip/{configId}
POST
/api/assets/zip/{configId}/_package/{packageName}
GET
/api/assets/published/{configId}/{assetId}/{rendition}
HEAD
/api/assets/published/{configId}/{assetId}/{rendition}
GET
/api/assets/published/{configId}/slug/{slug}/{rendition}
HEAD
/api/assets/published/{configId}/slug/{slug}/{rendition}
GET
/api/security/users
GET
/api/security/users/{id}
PUT
/api/security/users/{id}
POST
/api/security/users/{id}
DELETE
/api/security/users/{id}
GET
/api/security/groups
GET
/api/security/groups/{id}
PUT
/api/security/groups/{id}
POST
/api/security/groups/{id}
DELETE
/api/security/groups/{id}
GET
/api/security/roles
GET
/api/security/roles/{id}
PUT
/api/security/roles/{id}
POST
/api/security/roles/{id}
DELETE
/api/security/roles/{id}
GET
/api/security/serviceAccounts
POST
/api/security/serviceAccounts
GET
/api/security/serviceAccounts/{id}
PUT
/api/security/serviceAccounts/{id}
DELETE
/api/security/serviceAccounts/{id}
GET
/api/security/bundles
POST
/api/security/bundles
GET
/api/security/bundles/{id}
PUT
/api/security/bundles/{id}
DELETE
/api/security/bundles/{id}
GET
/api/security/info/group/{id}
GET
/api/security/info/role/{id}
GET
/api/security/info/serviceAccount/{id}
GET
/api/security/info/user/{id}
GET
/api/security/me/permissions
GET
/api/security/sync
POST
/api/security/update/{id}
PUT
/api/security/users/{id}/preferences
GET
/api/queue
GET
/api/queue/{name}/jobs
DELETE
/api/queue/{name}/jobs
GET
/api/queue/{name}/jobs/{id}
DELETE
/api/queue/{name}/jobs/{id}
GET
/api/admin/config
POST
/api/admin/config
GET
/api/admin/config/{id}
POST
/api/admin/config/{id}
DELETE
/api/admin/config/{id}
GET
/api/admin/webhooks
GET
/api/admin/webhooks/{id}
PUT
/api/admin/webhooks/{id}
POST
/api/admin/webhooks/{id}
DELETE
/api/admin/webhooks/{id}
GET
/api/admin/indexes
GET
/api/admin/indexes/{id}
POST
/api/admin/access/generatekey
GET
/api/admin/access/{id}
POST
/api/admin/access/{id}
GET
/api/admin/file/{type}/{id}
POST
/api/admin/file/{type}/{id}
GET
/api/admin/settings
PUT
/api/admin/settings
POST
/api/admin/process/{id}
GET
/api/admin/migration/ocm/{config_id}/repositories
GET
/api/admin/migration/ocm/{config_id}/repository/{repo_id}
GET
/api/admin/migration/ocm/{config_id}/channel/{channel_id}
GET
/api/sites
POST
/api/sites
GET
/api/sites/{id}
PUT
/api/sites/{id}
DELETE
/api/sites/{id}
GET
/api/sites/{id}/publish
POST
/api/sites/{id}/publish
GET
/api/sites/{id}/packages
GET
/api/sites/{id}/package/{packageName}
PUT
/api/sites/{id}/package/{packageName}
GET
/api/activity/{configId}/{assetId}
GET
/api/activity/{configId}/_package/{packageName}/{assetId}
GET
/api/dependencies/{configId}/{assetId}
GET
/api/dependencies/{configId}/_package/{packageName}/{assetId}
GET
/api/references/{configId}/{assetId}
GET
/api/references/{configId}/{assetId}/sites
GET
/api/references/{configId}/_package/{packageName}/{assetId}
GET
/api/references/{configId}/_package/{packageName}/{assetId}/sites
GET
/api/renditions/{configId}/{assetId}
PUT
/api/renditions/{configId}/{assetId}
POST
/api/renditions/{configId}/{assetId}
POST
/api/renditions/{configId}/{assetId}/regenerate
DELETE
/api/renditions/{configId}/{assetId}/{name}
GET
/api/renditions/{configId}/_package/{packageName}/{assetId}
PUT
/api/renditions/{configId}/_package/{packageName}/{assetId}
POST
/api/renditions/{configId}/_package/{packageName}/{assetId}
POST
/api/renditions/{configId}/_package/{packageName}/{assetId}/regenerate
DELETE
/api/renditions/{configId}/_package/{packageName}/{assetId}/{name}
GET
/api/queries/{repo}/{type}
GET
/api/user/token
GET
/api/user/integration_token
PUT
/api/user/preferences
PATCH
/api/user/preferences
POST
/api/workflow/events
POST
/api/workflow/status
GET
/api/workflow/{repo}/{packageName}
POST
/api/ai/cleanup
GET
/api/ai/{endpoint}/{configId}
POST
/api/ai/{endpoint}/{configId}
GET
/api/graphql/{path}
POST
/api/graphql/{path}
OPTIONS
/api/graphql/{path}
GET
/api/integration/{name}/{path}
PUT
/api/integration/{name}/{path}
POST
/api/integration/{name}/{path}
GET
/api/admin/workflow/connections
POST
/api/admin/workflow/connections
GET
/api/admin/workflow/connections/{id}
PUT
/api/admin/workflow/connections/{id}
DELETE
/api/admin/workflow/connections/{id}
GET
/api/admin/workflow/definitions
POST
/api/admin/workflow/definitions
GET
/api/admin/workflow/definitions/{id}
PUT
/api/admin/workflow/definitions/{id}
DELETE
/api/admin/workflow/definitions/{id}

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

JWT access token obtained from the /oauth2/token endpoint

Security scheme type: http

Bearer format: JWT