Update Streaming Endpoint

PATCH

https://app.mk.io/api/v1/projects/:project_name/media/streamingEndpoints/:endpoint_name

PATCH

/api/v1/projects/:project_name/media/streamingEndpoints/:endpoint_name

curl -X PATCH https://app.mk.io/api/v1/projects/project_name/media/streamingEndpoints/endpoint_name \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "location": "string",
  "properties": {
    "scaleUnits": 1
  }
}'

{
  "location": "string",
  "properties": {
    "scaleUnits": 1,
    "accessControl": {
      "ip": {
        "allow": [
          {
            "address": "string",
            "name": "",
            "subnetPrefixLength": 32
          }
        ]
      },
      "akamai": {
        "akamaiSignatureHeaderAuthenticationKeyList": [
          {
            "base64Key": "string",
            "expiration": "string",
            "identifier": "string"
          }
        ]
      }
    },
    "advancedSettingsName": "string",
    "cdnBasePath": "string",
    "cdnEnabled": false,
    "cdnProfile": "string",
    "created": "2024-01-15T09:30:00Z",
    "crossSiteAccessPolicies": {
      "clientAccessPolicy": "string",
      "crossDomainPolicy": "string"
    },
    "customHostNames": [
      "string"
    ],
    "description": "string",
    "hostName": "string",
    "lastModified": "2024-01-15T09:30:00Z",
    "maxCacheAge": 86400,
    "maxManifestCacheAge": 60,
    "provisioningState": "InProgress",
    "publicName": "string",
    "resourceState": "Creating",
    "serverCredentialNames": [
      "string"
    ],
    "shieldCache": {
      "scaleUnits": 1
    },
    "sku": {
      "name": "Standard",
      "capacity": 1
    },
    "urlStyle": "string",
    "cdnProvider": "StandardAkamai"
  },
  "name": "name",
  "tags": {}
}

Update a Streaming Endpoint. Only the Name and cdnProvider fields are immutable.

RBAC Capability Required: ams.streamingendpoint.update

Authentication

AuthorizationBearer

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

Path parameters

project_namestringRequired

endpoint_namestringRequired

Request

This endpoint expects an object.

locationstringRequired

The name of the location in which the streaming endpoint is located. This field must match the location in which the user's subscription is provisioned.

propertiesobjectRequired

The properties of the streaming endpoint.

tagsmap from strings to stringsOptional

A dictionary of key:value pairs describing the resource. Search may be implemented against tags in the future.

Response

The updated Streaming Endpoint

locationstring

The name of the location in which the streaming endpoint is located. This field must match the location in which the user's subscription is provisioned.

propertiesobject

The properties of the streaming endpoint.

namestringOptionalRead-onlyformat: "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$"1-64 characters

The name of the resource

tagsmap from strings to stringsOptional

A dictionary of key:value pairs describing the resource. Search may be implemented against tags in the future.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error