Channel Export

Channels API · import-export

POST /ui/connectors/channels-api/latest/export/

Export channels as a JSON payload.

Omit channels to export all. Set includeServices=false for a spec-only export (lighter; services regenerated from templates on import).

Request body

Content type: application/json · Required

• channels · object · Optional
  • One of the following variants:
    • array (list of strings)
      • Array items (string):
    • null (null)
• includeServices · boolean · Optional · Defaults to true
• description · object · Optional
  • One of the following variants:
    • string (string)
    • null (null)

Example request

curl -X POST "/ui/connectors/channels-api/latest/export/" \
  -H "Content-Type: application/json" \
  -d '{
  "channels": [
    "string"
  ],
  "includeServices": true,
  "description": "string"
}'

Responses

200 — Successful Response

Example:

null

422 — Validation Error

• detail · list of objects · Optional
  • Array items (object):
    • loc · list of objects · Required
      • Array items (object):
        • One of the following variants:
          • string (string)
          • integer (integer)
    • msg · string · Required
    • type · string · Required
    • input · any · Optional
    • ctx · object · Optional

Example:

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Source spec: channels-api · operationId: channel_export_export__post