Create a live event

PUT

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

PUT

/api/v1/projects/:project_name/media/liveEvents/:event_name

curl -X PUT https://app.mk.io/api/v1/projects/project_name/media/liveEvents/event_name \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "properties": {
    "encoding": {
      "encodingType": "None"
    },
    "input": {
      "accessControl": {
        "ip": {
          "allow": [
            {
              "address": "string",
              "name": "string",
              "subnetPrefixLength": 1
            }
          ]
        }
      },
      "accessToken": "string",
      "keyFrameIntervalDuration": "string",
      "timedMetadataEndpoints": [
        {
          "url": "string"
        }
      ]
    },
    "streamOptions": [
      "string"
    ],
    "useStaticHostname": true
  },
  "tags": {}
}'

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

Create a live event

RBAC Capability Required: ams.liveevent.create

Authentication

AuthorizationBearer

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

Path parameters

project_namestringRequired

event_namestringRequired

Request

This endpoint expects an object.

propertiesobjectRequired

The properties of the live event.

tagsmap from strings to stringsRequired

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.

locationstringOptional

Deprecated field. This field cannot be modified, only set during creation.

Response

A live event has been created

propertiesobject

The properties of the live event.

tagsmap from strings to strings

locationstringOptional

Deprecated field. This field cannot be modified, only set during creation.

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

The name of the resource

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error