update a live event.md

Update a Live Event

Media API · Live Events

PATCH https://app.mk.io/api/v1/projects/{project_name}/media/liveEvents/{event_name}

Update a live event. Currently only properties.pipeline is patchable.

RBAC Capability Required: ams.liveevent.update

Authentication

Authorization header — Bearer authentication of the form Bearer <token>.

Path parameters

Name	Type	Required	Description
`project_name`	string	Yes	—
`event_name`	string	Yes	—

Request body

Content type: application/json

properties · object · Required — The properties of the live event.
- pipeline · object · Optional — Not currently supported. AI pipeline settings
  - arguments · map from strings to list of objects · Optional — Arguments to each operation in the AI pipeline
    - [any key] · list of objects — map of additional properties
      - Array items (object):
        
        name · string · Required · 1-260 characters · pattern: ^[A-Za-z0-9-]+$_ — The name of the argument
        
        value · any · Required — The value of the argument
  - name · string · Optional · 0-255 characters — The name of the AI pipeline the Transform will execute.

Example request

curl -X PATCH "https://app.mk.io/api/v1/projects/{project_name}/media/liveEvents/{event_name}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "properties": {
    "pipeline": {
      "arguments": {
        "operation1": [
          {
            "name": "language",
            "value": "en-US"
          }
        ],
        "operation2": [
          {
            "name": "length",
            "value": "3.7m"
          }
        ]
      },
      "name": "string"
    }
  }
}'

Responses

200 — Updated

location · string · Optional — Deprecated field. This field cannot be modified, only set during creation.
name · string · Optional · 2-32 characters · pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$ — The name of the resource
properties · object · Required — The properties of the live event.
- created · string · Optional — The time when the live event was created.
- crossSiteAccessPolicies · object · Optional — The configuration for cross-site access policies. This includes the XML content of the client access policy and cross-domain policy files. This field cannot be modified, only set during creation.
  - clientAccessPolicy · string or null · Optional — The XML content of the client access policy file. Search 'clientaccesspolicy.xml' to learn more.
  - crossDomainPolicy · string or null · Optional — The XML content of the cross-domain policy file. Search 'crossdomain.xml' to learn more.
- description · string · Optional · 0-4096 characters — An optional description for the live event. This field cannot be modified, only set during creation.
- encoding · object · Required — The encoding configuration for the live event. This includes settings like encoding type and preset name. This field cannot be modified, only set during creation.
  - encodingType · enum · Required — Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers
    - Allowed values: None, PassthroughBasic, PassthroughStandard, Premium1080p, Standard
  - keyFrameInterval · string · Optional · Defaults to PT2S — Use an ISO 8601 time value between 1 and 10 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events.
  - presetName · string · Optional — Defaults to either Default720p or Default1080p depending on encoding type. May be used to specify alternative encoding templates - contact support for assistance if your needs are complex.
  - stretchMode · enum · Optional — Determines how aspect ratio will be preserved when there is a mismatch between the input and output aspect ratios. Autofit to pad the output. Autosize to ignore the output ratio and pick the largest dimension that fits, and None to clip the content.
    - Allowed values: None, AutoSize, AutoFit
- hostnamePrefix · string · Optional — Applied when useStaticHostname=true to specify the first part of the hostname for all input and preview addresses. This field cannot be modified, only set during creation.
- input · object · Required — The configuration for the input of the live event. This includes settings like key frame interval duration, streaming protocol, access token, and endpoints. This field cannot be modified, only set during creation.
  - accessControl · object · Required — Access control for live event input.
    - ip · object · Required — The IP access control for the live event inputs.
      - allow · list of objects · Required — The IP ranges that will be allowed to access the preview. If empty, all IPs will be allowed.
        
        Array items (object):
        
        address · string · Required — The IP address or DNS with port or protocol
        
        name · string · Required · 1-32 characters — The name of the IP range. This is for your reference only. examples: 'everyone', 'dave's house', 'corp vpn'.
        
        subnetPrefixLength · integer · Required · 0 to 32 — The subnet prefix length (see CIDR notation).
  - accessToken · string · Required · 10-79 characters — For RTMP, a UUID in string form to uniquely identify the stream. For SRT, an arbitrary string of between 10 and 79 characters, used as the passphrase. This can be specified at creation time but cannot be updated. If omitted or null, the service will generate a unique value.
  - endpoints · list of objects · Optional — Populated server-side. The input endpoints for the live event.
    - Array items (object):
      - protocol · string · Optional — The streaming protocol for the endpoint. Possible values include: 'SRT', 'RTMP'.
      - url · string · Optional — The IP address or DNS with port and protocol
  - keyFrameIntervalDuration · string · Required — ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events.
  - streamingProtocol · enum · Optional · Defaults to RTMP — The input protocol for the live event. This is specified at creation time and cannot be updated.
    - Allowed values: RTMP, RTMPS, SRT
  - timedMetadataEndpoints · list of objects · Required — The metadata endpoints for the live event.
    - Array items (object):
      - url · string · Required
- lastModified · string · Optional — The last time the live event was modified.
- pipeline · object · Optional — Not currently supported. AI pipeline settings
  - arguments · map from strings to list of objects · Optional — Arguments to each operation in the AI pipeline
    - [any key] · list of objects — map of additional properties
      - Array items (object):
        
        name · string · Required · 1-260 characters · pattern: ^[A-Za-z0-9-]+$_ — The name of the argument
        
        value · any · Required — The value of the argument
  - name · string · Required · 0-255 characters — The name of the AI pipeline the Transform will execute.
- preview · object · Optional — The configuration for the preview of the live event. This includes settings like preview locator, streaming policy name, access control, and endpoints. This field cannot be modified, only set during creation.
  - accessControl · object · Optional — Address-based ACLs for access to the preview.
    - ip · object · Required — The IP access control for the preview endpoint. Determines who will be able to access preview content.
      - allow · list of objects · Required — The IP ranges that will be allowed to access the preview. If empty, all IPs will be allowed.
        
        Array items (object):
        
        address · string · Required — The IP address or DNS with port or protocol
        
        name · string · Required · 1-32 characters — The name of the IP range. This is for your reference only. examples: 'everyone', 'dave's house', 'corp vpn'.
        
        subnetPrefixLength · integer · Required · 0 to 32 — The subnet prefix length (see CIDR notation).
  - alternativeMediaId · string · Optional — Not currently supported. Will be used to support DRM license acquisition for preview content.
  - endpoints · list of objects · Optional — Populated server-side. The endpoints that are used for previewing the live event.
    - Array items (object):
      - protocol · string · Optional — The streaming protocol for the endpoint. Possible values include: 'SRT', 'RTMP'.
      - url · string · Optional — The IP address or DNS with port and protocol
  - previewLocator · string · Optional · format: uuid — The ID of the locator for the preview. This is automatically generated when the live event is created, and removed when the live Event is deleted. The caller may specify a locator GUID, in which case the caller must ensure that the GUID is unique and not already used by another resource.
  - streamingPolicyName · string · Optional · <=260 characters · Defaults to Predefined_ClearStreamingOnly — The name of the DRM streaming policy for the live event preview. Defaults to Predefined_ClearStreamingOnly and no other value is presently supported.
- provisioningState · string · Optional — The current provisioning state of the resource. One of 'InProgress', 'Succeeded', or 'Failed'
- resourceState · enum · Optional — The current state of the resource. One of 'Stopped', 'Starting', 'Running', 'Stopping', or 'Deleting'.
  - Allowed values: Stopped, Starting, Running, Stopping, Deleting
- streamOptions · list of strings · Required — A list of streaming options for the live event. One of 'Default' or 'LowLatency'. Only one value permitted in the list. This field cannot be modified, only set during creation.
  - Array items (string):
- transcriptions · list of items · Optional — Not currently supported. Transcription settings for the live event. This field cannot be modified, only set during creation.
  - Array items (any):
- useStaticHostname · boolean · Required — A boolean value that indicates whether a static hostname is assigned to input and preview endpoints. If not set, will default to 'false' and IP addresses will be provided. This field cannot be modified, only set during creation.
tags · map from strings to string · Required — A dictionary of tags associated with the live event. Maximum number of tags: 16. Maximum length of a tag: 64 characters. For the purposes of the $label_key and $label queries this field will be checked. This field cannot be modified, only set during creation.
- [any key] · string — map of additional properties

Example:

{
  "location": "string",
  "name": "name",
  "properties": {
    "created": "string",
    "crossSiteAccessPolicies": {
      "clientAccessPolicy": "string",
      "crossDomainPolicy": "string"
    },
    "description": "string",
    "encoding": {
      "encodingType": "None",
      "keyFrameInterval": "PT2S",
      "presetName": "string",
      "stretchMode": "None"
    },
    "hostnamePrefix": "string",
    "input": {
      "accessControl": {
        "ip": {
          "allow": [
            {
              "address": "string",
              "name": "string",
              "subnetPrefixLength": 0
            }
          ]
        }
      },
      "accessToken": "string",
      "endpoints": [
        {
          "protocol": "string",
          "url": "string"
        }
      ],
      "keyFrameIntervalDuration": "string",
      "streamingProtocol": "RTMP",
      "timedMetadataEndpoints": [
        {
          "url": "string"
        }
      ]
    },
    "lastModified": "string",
    "pipeline": {
      "arguments": {
        "operation1": [
          {
            "name": "language",
            "value": "en-US"
          }
        ],
        "operation2": [
          {
            "name": "length",
            "value": "3.7m"
          }
        ]
      },
      "name": "string"
    },
    "preview": {
      "accessControl": {
        "ip": {
          "allow": [
            {
              "address": "string",
              "name": "string",
              "subnetPrefixLength": 0
            }
          ]
        }
      },
      "alternativeMediaId": "string",
      "endpoints": [
        {
          "protocol": "string",
          "url": "string"
        }
      ],
      "previewLocator": "00000000-0000-0000-0000-000000000000",
      "streamingPolicyName": "Predefined_ClearStreamingOnly"
    },
    "provisioningState": "string",
    "resourceState": "Stopped",
    "streamOptions": [
      "string"
    ],
    "transcriptions": [
      null
    ],
    "useStaticHostname": true
  },
  "tags": {
    "key": "string"
  }
}

400 — Bad Request

error · object · Required — Pertinent information about the error
- code · string · Required — The error code.
- detail · string · Required — The error message.
- extraDetail · map from strings to any · Optional — Extra information regarding this error.
  - [any key] · any — map of additional properties
ref · string · Required — A reference to the request that caused the error.
status · integer · Required — The HTTP status code

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

401 — Unauthorized

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

403 — Forbidden

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

404 — Not Found

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

429 — Too Many Requests

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

500 — Internal Server Error

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}