list channels.md

List Channels

Channels API · channels

GET /ui/connectors/channels-api/latest/channels/

List all channels with OData-style filtering and pagination.

Filter examples:

Operators: eq, ne, lt, le, gt, ge, and, or Functions: contains(), tolower(), toupper()

All channels are loaded and hydrated with live status before filtering, sorting, and pagination are applied in-memory. This is viable because channel count is bounded (tens, not thousands).

Query parameters

Name Type Required Description
$top integer No Max items per page 1 to 1000 Defaults to 1000
$skiptoken integer No Offset into results >=0 Defaults to 0
$filter object No OData filter expression
$orderby string No Sort field(s) with optional asc/desc; comma-delimited for multi-key, e.g. 'status/health/severity asc, metadata/created desc' Defaults to metadata/created
$select object No Comma-separated fields; when present, status hydration is skipped

Example request

curl -X GET "/ui/connectors/channels-api/latest/channels/?%24top=1000&%24skiptoken=0&%24orderby=metadata%2Fcreated"

Responses

200 — Successful Response

Example:

{
  "value": [
    {
      "kind": "BeamChannel",
      "metadata": {
        "name": "string",
        "displayName": "string",
        "created": "2024-01-01T00:00:00Z"
      },
      "spec": {
        "type": "EncodingContribution",
        "state": "Stopped",
        "inputs": [],
        "transform": {
          "encoding": {
            "video": {
              "codec": "H264High",
              "videoFormat": "1920x1080p",
              "bitrate": 6000000,
              "frameRate": "TrueMotion"
            },
            "audios": []
          },
          "abrEncoding": {
            "representations": [],
            "sharedAudios": []
          },
          "multiplexing": {
            "enabled": false
          }
        },
        "outputs": []
      },
      "status": {
        "state": "Stopped",
        "health": {
          "severity": "Clear"
        },
        "inputs": [],
        "outputs": [],
        "syncState": "Ok",
        "syncError": []
      },
      "serviceIds": [
        "string"
      ]
    }
  ],
  "@odata.nextLink": "string",
  "supplemental": {
    "kind": "BeamChannelList",
    "count": 0,
    "operation": "list",
    "pagination": {
      "start": 0,
      "end": 0,
      "records": 0,
      "total": 0
    }
  }
}

422 — Validation Error

Example:

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

503 — Service unavailable

No response body.


Source spec: channels-api · operationId: list_channels_channels__get