Get Source

GET

https://app.mk.io/api/v1/projects/:project_name/media/sources/:name

GET

/api/v1/projects/:project_name/media/sources/:name

curl https://app.mk.io/api/v1/projects/project_name/media/sources/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": {
    "transport": {
      "type": "UDP",
      "allowList": [
        "string"
      ],
      "encryptionStandard": "None",
      "ipResource": {
        "type": "None"
      },
      "latency": 0.5,
      "maxBitrate": 30000000,
      "maxConnections": 10,
      "maxOverheadBandwidth": 100,
      "passPhrase": "",
      "password": "string",
      "port": 5000,
      "streamId": "",
      "streamKey": "",
      "url": "string",
      "user": "string",
      "urls": [
        "string"
      ]
    },
    "contentName": "sports1",
    "networkName": "internet"
  },
  "status": {
    "networkDisplayName": "string",
    "shortId": "string",
    "state": "Inactive",
    "transport": {
      "urls": [
        "string"
      ]
    }
  }
}

Get a source by name. To learn more about sources, read Content and sources.

RBAC Capability Required: flow.source.get

Authentication

AuthorizationBearer

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

Path parameters

project_namestringRequired

namestringRequired

Response

A single source

kindstring

The kind of record.

metadataobject

Source metadata.

specobject

Source specification.

statusobject

Source 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