Update Destination

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

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

RBAC Capability Required: flow.destination.update

Authentication

Authorization Bearer

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

Path parameters

project_name string Required
name string Required

Request

This endpoint expects an object.

metadataobjectDefaultPatchMetadataOptional
Resource metadata.
Show 2 propertiesHide 2 properties
displayNamestringOptional1-255 characters
A human-readable name for the resource.
labelsmap from strings to stringOptional
A dictionary of labels associated with the resource. Maximum number of labels: 32. Maximum length of a label or value: 256 characters. Label: alphanumeric, hyphens and underscores. Value: alphanumeric, hyphens, underscores and spaces.
Show value schemaHide value schema
[any key]string

Response

200 The updated destination
kindstringRequired
The kind of record.
metadataobjectMetadataSchemaRequired
Destination metadata.
Show 10 propertiesHide 10 properties
createdstringOptionalformat: date-time
The time when the resource was created
createdBystringOptionalformat: uuid
ID of the user who created the resource
createdByEmailstringOptional
Email of the user who created the resource
displayNamestringOptional
The display name of the resource
idstringRequiredformat: uuid
The ID of the resource
labelsmap from strings to stringOptional
A dictionary of labels associated with the resource
Show value schemaHide value schema
[any key]string
namestringOptional
The name of the resource
updatedstringOptionalformat: date-time
The time when the resource was last updated
updatedBystringOptionalformat: uuid
ID of the user who last updated the resource
updatedByEmailstringOptional
Email of the user who last updated the resource
specobjectDestinationBodySpecRequired
Destination specification.
Show 3 propertiesHide 3 properties
aquilaSourceIdstringOptional1-32 characters
The ID of an Aquila source to be used as the destination for a flow.
networkNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
Name of the <glossary:network> that this destination is available on. Only <glossary:flow>s that can reach this network will be able to use this destination.
transportobjectTransportSpecJsonFragmentOptional
Details of the <glossary:transport> that the content will be carried on. To learn more about the kinds of transport that can be configured, read Set up transports on sources and destinations.
Show 16 propertiesHide 16 properties
allowListlist of stringsOptional

List of IP addresses that are allowed to connect, if the transport type supports it.

The following transport types can use the allowList field: SRTListener.

encryptionStandardenumOptionalDefaults to None

Encryption standard for the transport, if the transport type supports it.

The following transport types can use the encryptionStandard field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

Allowed values:NoneAES128AES192AES256
ipResourceobjectIpResourceJsonFragmentOptional

Add an IP resource reservation for the transport. This is necessary for <glossary:source>s and <glossary:destination>s that need to access a <<glossary:SaaS site>> through a public IP address or public URL.

The following transport types can use the ipResource field: SRTListener. This field cannot be modified, only set during creation.

Show 1 propertyHide 1 property
typeenumRequired

Type of IP resource reservation:

  • External means reserve a public IP address,
  • Internal means reserve an internal IP address (please contact MediaKind personnel for usage), and
  • None means don't try to reserve an IP resource.

Transports between on-prem devices don't need to explicitly reserve an IP address.

Allowed values:NoneExternalInternal
latencydoubleOptionalDefaults to 0.5

Minimum Latency, in seconds, for the transport, if the transport type supports it.

The following transport types can use the latency field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

maxBitrateintegerOptionalDefaults to 30000000

Maximum bitrate, in bits per second, expected through each individual connection to the Listener.

The following transport types can use the maxBitrate field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

maxConnectionsintegerOptionalDefaults to 10

Maximum number of connections for a Listener destination. Overrides the flow output maxConnections setting if present.

The following transport types can use the maxConnections field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

maxOverheadBandwidthintegerOptional5 to 100Defaults to 100

Maximum Overhead Bandwidth, as an integer (e.g., 100), for the transport, if the transport type supports it.

The following transport types can use the maxOverheadBandwidth field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

passPhrasestringOptionalDefaults to

Password phrase for the transport, if the transport type supports it.

The following transport types can use the passPhrase field: SRTCaller, SRTListener.

passwordstringOptional

Password for HLS pull authentication.

For sources, this field can be updated via PATCH when the transport type is HLSPullInput. For all other transport types, it can only be set during creation.

portintegerOptionalDefaults to 5000

Port for the transport, if the transport type supports it.

The following transport types need the port field: SRTListener. This field cannot be modified, only set during creation.

streamIdstringOptionalDefaults to

The SRT stream ID sent by the caller during the SRT handshake. Used by the listener to identify or route the stream. Optional.

The following transport types can use the streamId field: SRTCaller. This field cannot be modified, only set during creation.

streamKeystringOptionalDefaults to

The RTMP stream key (appended to the URL when connecting).

The following transport types need the streamKey field: RTMPPushOutput. This field cannot be modified, only set during creation.

typeenumRequired
Type of transport. This field cannot be modified, only set during creation.
Allowed values:UDPSDISRTCallerSRTListenerHLSPullInputRTMPPushOutput
urlstringOptional

The URL for the transport, if the transport type supports it.

The following transport types need the url field: SRTCaller, UDP, SDI, HLSPullInput, RTMPPushOutput.

For sources, this field can be updated via PATCH when the transport type is SRTCaller or HLSPullInput. For all other transport types, and for destinations, it can only be set during creation.

urlslist of stringsOptionalDeprecated
DEPRECATED: Use url instead. This is provided for backwards compatibility and will be removed in a future release. If urls is used, only the first URL will be considered. If both url and urls are provided, url takes precedence.
userstringOptional

Username for HLS pull authentication.

For sources, this field can be updated via PATCH when the transport type is HLSPullInput. For all other transport types, it can only be set during creation.

statusobjectDestinationStatusSchemaRequired
Destination status.
Show 3 propertiesHide 3 properties
networkDisplayNamestringOptional
The display name of the network this destination is available on.
stateenumOptional
Indicates if the destination is currently in use by any active <glossary:flow>s.
Allowed values:InactiveActive
transportobjectTransportStatusJsonFragmentOptional
Transport status information for the destination.
Show 1 propertyHide 1 property
urlslist of stringsOptional

The URLs configured or allocated/discovered for the transport.

Where the spec.transport.url field is supported by the transport type (e.g. an SRTCaller), the urls field will contain that data. Where the system automatically allocates/discovers one or more URLs (e.g. an SRTListener), the urls field will contain that data.

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
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