Skip to navigation
Channels APIImport Export

Channel Import

Import channels from a JSON payload.

mode=merge (default): create missing, update changed, leave others alone. mode=replace: delete any channel not in the payload, then create/update. An empty channels list with mode=replace deletes all channels.

Returns immediately. Background tasks push service configs to the controller; observe final per-channel state via GET /channels/{id}/ (syncState).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
payloadobjectRequired
modeenumOptional
Allowed values:
stateenum or nullOptional
Allowed values:

Response

Successful Response
importedlist of objectsOptional
deletedlist of stringsOptional
errorslist of stringsOptional
warningslist of stringsOptional

Errors

422
Unprocessable Entity Error