Get Live Channel

GET

https://app.mk.io/api/v1/projects/:project_name/live/liveChannels/:name

GET

/api/v1/projects/:project_name/live/liveChannels/:name

curl https://app.mk.io/api/v1/projects/project_name/live/liveChannels/name \
     -H "Authorization: Bearer <token>"

{
  "kind": "string",
  "metadata": {
    "id": "string",
    "created": "2024-01-15T09:30:00Z",
    "createdBy": "string",
    "createdByEmail": "string",
    "displayName": "string",
    "labels": {
      "label1": "value1",
      "label2": "value2"
    },
    "name": "string",
    "updated": "2024-01-15T09:30:00Z",
    "updatedBy": "string",
    "updatedByEmail": "string"
  },
  "spec": {
    "inputs": [
      {
        "contentName": "channel-1",
        "flowName": "flow-1",
        "refiner": {
          "flow": {
            "name": "string"
          },
          "labelMatch": {
            "key": "string",
            "value": "string"
          }
        },
        "sourceName": "source-1",
        "transformInput": "encoding/input_1"
      }
    ],
    "outputs": [
      {
        "contentName": "string",
        "destinationName": "production-1",
        "refiner": {},
        "transformOutput": "encoding/output_1",
        "transport": {
          "maxConnections": 10
        }
      }
    ],
    "state": "Running",
    "transform": {
      "archiveWindowLength": "string",
      "assetName": "string",
      "assetPath": "string",
      "encodingLive": {
        "advancedSettingsName": "string",
        "configOverrides": {
          "operations": [
            {
              "op": "add",
              "path": "string",
              "search": "string"
            }
          ],
          "type": "application/json-patch+json"
        },
        "configRef": {
          "name": "string",
          "version": "latest"
        },
        "configValues": {
          "audio1label": "Spanish",
          "audio1lang": "spa",
          "audio1pid": 257,
          "epochts": false
        }
      },
      "streamConditioning": {
        "advancedSettingsName": "string",
        "configOverrides": {
          "operations": [
            {
              "op": "add",
              "path": "string",
              "search": "string"
            }
          ],
          "type": "application/json-patch+json"
        },
        "configRef": {
          "name": "string",
          "version": "latest"
        },
        "configValues": {
          "audio1label": "Spanish",
          "audio1lang": "spa",
          "audio1pid": 257,
          "epochts": false
        }
      },
      "type": "string"
    },
    "refiner": {},
    "siteName": "world"
  },
  "status": {
    "deviceDisplayName": "Device 1",
    "deviceName": "device-1",
    "info": "There was an issue with start due to a mismatch of Template inputs and configured inputs.",
    "inputs": [
      {
        "contentDisplayName": "Channel 1",
        "contentName": "channel-1",
        "deviceInterfaceName": "eth0",
        "networkDisplayName": "Internet",
        "networkName": "internet",
        "sourceDisplayName": "Channel 1 SRT",
        "sourceName": "channel-1-srt",
        "sourceShortId": "a1b2c3d4e5f6",
        "sourceUrl": "srt://10.10.10.1:6000",
        "upstreamFlowName": "channel-1-encode"
      }
    ],
    "metrics": {
      "mk_resource_status": [
        {
          "labels": {
            "mkio_stage": "encode"
          },
          "value": 0
        },
        {
          "labels": {
            "mkio_stage": "output"
          },
          "value": 0
        },
        {
          "labels": {
            "mkio_stage": "resource"
          },
          "value": 0
        }
      ]
    },
    "monitoring": {},
    "outputs": [
      {
        "contentDisplayName": "string",
        "contentName": "string",
        "destinationDisplayName": "production-1",
        "destinationUrl": "srt://10.10.10.2:6000",
        "deviceInterfaceName": "eth0",
        "downstreamFlowNames": [
          "string"
        ],
        "networkDisplayName": "Internet",
        "networkName": "internet",
        "transport": {
          "maxBitrate": 1,
          "latency": 10,
          "maxConnections": 10
        }
      }
    ],
    "shortId": "a1b2c3d4e5f6",
    "siteDisplayName": "World",
    "state": "Started",
    "transform": {
      "streamPersonalization": {
        "hostName": "string"
      }
    }
  }
}

Get a Live Channel by name.

RBAC Capability Required: transform.livechannel.get

Authentication

AuthorizationBearer

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

Path parameters

project_namestringRequired

namestringRequired

Query parameters

$detailedStatusstringOptional

Include extra status information in the response.

Response

A single Live Channel.

kindstring

The kind of record.

metadataobject

Flow metadata.

specobject

Flow specification.

statusobject

Flow status.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error