Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Channel endpoints

The endpoints that create, validate, version and move a channel, and what each refuses.

MethodPathDescription
POST/api/v1/admin/channelsCreate channel (as draft). Optional tags: ["..."] — selection labels read back by ?tag= filters and package export
GET/api/v1/admin/channelsList channels. Filter with ?status=, ?channel_type=, ?protocol=, ?tag=
GET/api/v1/admin/channels/{id}Get channel by ID
PUT/api/v1/admin/channels/{id}Update draft channel
DELETE/api/v1/admin/channels/{id}Delete channel (all versions)
PATCH/api/v1/admin/channels/{id}/statusChange status (active/archived) — see Status changes
GET/api/v1/admin/channels/{id}/versionsList channel version history
POST/api/v1/admin/channels/{id}/versionsCreate new draft version from active channel
POST/api/v1/admin/channels/importBulk import channels (as drafts). ?dry_run=true validates without writing; ?on_conflict=fail|skip|new_version picks what an existing id means
GET/api/v1/admin/channels/exportExport every matching channel, in the shape /import accepts. Filter with ?tag=, ?status=
POST/api/v1/admin/channels/validateValidate a channel definition without saving

PATCH /{id}/status on a channel:

  • Activation refuses a route another active channel claims.
  • Activation refuses a channel whose workflow is missing or not active.
  • Activation refuses a name another active channel holds.
  • ?dry_run=true and ?reload=defer compose as described under Status changes.

Last verified 14 September 2026