Create

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

Creates a Live Output

Authentication

Authorization Bearer

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

Path parameters

project_name string Required
event_name string Required
output_name string Required

Request

This endpoint expects an object.

propertiesobjectLiveOutputPutPropertiesRequired
The properties of the live output.
Show 7 propertiesHide 7 properties
archiveWindowLengthstringRequired
ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content.
assetNamestringRequired1-260 characters
The name of the asset that the live output will write to.
descriptionstringOptional0-4096 characters
The description of the live output.
hlsobjectLiveOutputHlsOptional
The HLS configuration.
Show 1 propertyHide 1 property
fragmentsPerTsSegmentintegerOptional1 to 100000000Defaults to 1
The number of fragments per HLS segment.
manifestNamestringOptional1-64 characterspattern: ^[a-zA-Z0-9\-]+[a-zA-Z0-9]$
The name of the manifest file. If not provided, the service will generate one automatically. This is the filename that will appear in playback URLs.
outputSnapTimeintegerOptionalDefaults to 0
Not supported. The output snapshot time. This is the wall clock time, in unix epoch seconds, that the live output will begin recording from.
rewindWindowLengthstringOptional
Not supported. ISO 8601 timespan duration of the rewind window length during live playback. This is the amount of time that the live output will be able to rewind.

Response

201 Live Output created
namestringOptional1-256 characterspattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
The name of the resource
propertiesobjectLiveOutputPropertiesRequired
The properties of the live output.
Show 11 propertiesHide 11 properties
archiveWindowLengthstringRequired
ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content.
assetNamestringRequired1-260 characters
The name of the asset that the live output will write to.
createdstringOptional
The exact time the live output was created.
descriptionstringOptional0-4096 characters
The description of the live output.
hlsobjectLiveOutputHlsOptional
The HLS configuration.
Show 1 propertyHide 1 property
fragmentsPerTsSegmentintegerOptional1 to 100000000Defaults to 1
The number of fragments per HLS segment.
lastModifiedstringOptional
The exact time the live output was last modified.
manifestNamestringOptional1-64 characterspattern: ^[a-zA-Z0-9\-]+[a-zA-Z0-9]$
The name of the manifest file. If not provided, the service will generate one automatically. This is the filename that will appear in playback URLs.
outputSnapTimeintegerOptionalDefaults to 0
Not supported. The output snapshot time. This is the wall clock time, in unix epoch seconds, that the live output will begin recording from.
provisioningStatestringOptional
The provisioning state of the live output.
resourceStateenumOptional
The resource state of the live output.
Allowed values:CreatingDeletingRunning
rewindWindowLengthstringOptional
Not supported. ISO 8601 timespan duration of the rewind window length during live playback. This is the amount of time that the live output will be able to rewind.

Errors

400 Bad Request
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
409 Conflict
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code