Update Destination

PATCH

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

PATCH

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

curl -X PATCH https://app.mk.io/api/v1/projects/project_name/media/destinations/name \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "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": {
    "aquilaSourceId": "1bfa932d36604506824fdd78642ad08f",
    "networkName": "network-wan",
    "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"
      ]
    }
  },
  "status": {
    "networkDisplayName": "string",
    "state": "Inactive",
    "transport": {
      "urls": [
        "string"
      ]
    }
  }
}

Update a destination. To learn more about destinations, read Destinations.

RBAC Capability Required: flow.destination.update

Authentication

AuthorizationBearer

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

Path parameters

project_namestringRequired

namestringRequired

Request

This endpoint expects an object.

metadataobjectOptional

Resource metadata.

Response

The updated destination

kindstring

The kind of record.

metadataobject

Destination metadata.

specobject

Destination specification.

statusobject

Destination 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