Patch Channel

patch/api/channels/:channel_id/

Update channel displayName or state.

Path parameters

channel_idstringRequired

Request

This endpoint expects an object.

Loading schema details…

Response

200Successful Response

Loading schema details…

Errors

422Validation Error

Loading schema details…

503Service unavailable

No response body.

patch/api/channels/{channel_id}/

curl -X PATCH "/api/channels/{channel_id}/" \
  -H "Content-Type: application/json" \
  -d '{
  "metadata": {
    "displayName": "string"
  },
  "spec": {
    "state": "Running"
  }
}'

200Successful Response

{
  "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": []
      },
      "multiplexing": {
        "enabled": false
      }
    },
    "outputs": []
  },
  "status": {
    "state": "Stopped",
    "health": {
      "severity": "Clear"
    },
    "inputs": [],
    "outputs": [],
    "syncState": "Ok",
    "syncError": [],
    "errors": [],
    "unsyncedFields": []
  },
  "serviceIds": [
    "string"
  ]
}