List Live Events
List Live Events on the specified project.
Listing, Sorting and Filtering Live Events
This endpoint returns the list of Live Events in the specified project.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas
where each one can optionally specify asc or desc.
Sorting is valid on the following fields: created, createdBy, displayName, id, labels, name, spec/state, spec/transform/type, status/state, status/transformType, updated, updatedBy
Filtering
There are two ways to filter the set of returned Live Events from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.
The $filter query parameter allows for Live Events to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, displayName, id, labels, name, spec/inputs/content, spec/outputs/destination, spec/siteName, spec/state, spec/transform/type, status/deviceName, status/state, status/transformType, updated, updatedBy, updatedByEmail, updatedByName
$label_key and $label are specific to querying Live Events based on their labels. Labels are a set of key-value pairs that can be used to identify Live Events with
any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of Live Events.
Examples:
?$top=10 - Returns only the first 10 Live Events from the list.
?$orderby=name desc - Sorts Live Events by name in descending order.
?$filter=name eq 'descriptive name' - Returns Live Events that match the provided name.
?$orderby=created desc - Sorts Live Events by creation date in descending order.
?$filter=created ge 2021-01-01T00:00:00Z - Returns Live Events created after January 1, 2021.
?$label=studio=paravalley - Returns Live Events with the label studio set to paravalley.
?$label=release-date~2023 - Returns Live Events with the label release-date set to a value that contains 2023.
?$label_key=studio&label_key=release-date - Returns Live Events with any value set for the studio label and the release-date label.
RBAC Capability Required: transform.liveevent.get
Authentication
Authorization Bearer
Bearer authentication of the form Bearer <token>, where token is your
auth token.
Path parameters
project_name string Required
Query parameters
$orderby string Optional
Specifies the key by which the result collection should be ordered.
$filter string Optional
Restricts the set of items returned.
$top string Optional
Specifies a non-negative integer
n that limits the number of items returned from a collection.
The service returns the number of available items up to but not greater than the specified value n. $skiptoken string Optional
Specifies a start offset to support paginated results.
Use
@odata.nextLink in the result object to enumerate the collection -
it will be present only if there's more than one page of entities. $label_key string Optional
Filters the set to the specified label key.
If multiple $label_keys are specified, matching items must have all labels.
$label string Optional
Filters the set to the specified label key/value pair.
Supports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.
$detailedStatus string Optional
Include extra status information in the response.
Response
200 List of Live Events
@odata.nextLinkstringOptional
@odata.nextLink URL if the page length and number of items match.
Supplemental info
Show 5 propertiesHide 5 properties
countintegerRequired
Number of items returned
kindstringRequired
Type of items in the list
operationstringRequired
Operation type. Should always say 'list'
Pagination info
Show 4 propertiesHide 4 properties
endintegerRequired
Position of the last item in the list
recordsintegerRequired
Total number of items returned in the list
startintegerRequired
Position of the first item in the list
totalintegerRequired
Total number of items in the project
Project info
Show 2 propertiesHide 2 properties
idstringRequired
Project ID
namestringRequired
Project name
A list of flows.
Show 4 propertiesHide 4 properties
kindstringRequired
The kind of record.
Flow 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
Flow specification.
Show 6 propertiesHide 6 properties
List of flow inputs.
Read Flow inputs and outputs to learn more about how to connect flow inputs between content and flow transform inputs.
Show 5 propertiesHide 5 properties
contentNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The <glossary:content> that the flow input is connected to. This also influences the content that will be available on the flow outputs.
Read Resolving content to learn more about how content is resolved to the <glossary:source>s and <glossary:flow>s that can supply it.
flowNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The upstream <glossary:flow> that the flow input is connected to. This also influences the content that will be available on the flow outputs.
The <glossary:refiners> that influence how this flow input will be assigned and how content will be resolved for it. For example, flow inputs can be constrained to specific upstream <glossary:flow>s and <glossary:source>s. To learn more, read Flow input refiners.
Show 2 propertiesHide 2 properties
Refiner to restrict a flow's input to originate from a specific flow.
Show 1 propertyHide 1 property
namestringRequired
Name of the resource to match.
Refiner to restrict a flow's input to originate from one of a set of both flows and content sources.
Show 2 propertiesHide 2 properties
keystringRequired
Name of the label to match against. Case sensitive.
valuestringRequired
The desired value of the label. Case sensitive.
sourceNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The <glossary:source> that the flow input is connected to. This also influences the content that will be available on the flow outputs.
transformInputstringOptional1-128 characters
The name of the input pin to connect in the associated processing config. Retrieve the config through the Templates API and use a name from
status.inputPins[].name.List of flow outputs.
Read Flow inputs and outputs to learn more about how to connect flow outputs between flow transform outputs and destinations or to make them available to other flows.
Show 5 propertiesHide 5 properties
contentNamestringOptional
Optional, sets the <glossary:content> that is provided by this flow output.
destinationNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The destination to connect the flow output to. Omit this field to create an <<glossary:internal flow output>>.
Read Flows to learn more about how to connect flows to other flows.
The <glossary:refiners> that influence how this flow output will be assigned. This is a placeholder for future functionality.
transformOutputstringOptional1-128 characters
The name of the output pin to connect in the associated processing config. Retrieve the config through the Templates API and use a name from
status.outputPins[].name.Transport setting overrides for this specific flow output. If not specified, the transport will use the default settings.
Show 1 propertyHide 1 property
maxConnectionsintegerOptional>=1
Optional, specifies the maximum number of connections for this output if no destination is specified.
The <glossary:refiners> that influence how this flow will be assigned. This is a placeholder for future functionality.
siteNamestringOptionalpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The name of the <glossary:site> where the flow will run. If omitted, the site is inferred from the flow type: cloud flows default to the project's cloud site; device flows default to the 'world' site.
stateenumRequired
The desired state of the flow.
Allowed values:StoppedRunning
transformobjectRequired
Configuration for the transformation that this flow performs
Show 4 variantsHide 4 variants
Discriminated by type. Select one variant:
LiveChannelobjectLiveChannelFlow
A 24x7 flow that takes live input and encodes it, storing the material in the asset named by the required assetName field.
Starting a LiveChannel flow will immediately charge the full monthly fee to your payment method, no matter how much of the month remains.
Please see LiveEvent for encoding billed by the minute.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.
LiveEventobjectLiveEventFlow
A flow that takes live input and encodes it, storing the material in the asset named by the required assetName field.
A LiveEvent flow is billed by the minute, please see LiveChannel for encoding billed by the month.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.
StaticMultiviewChannelobjectStaticMultiviewChannelFlow
A 24x7 flow that takes multiple live inputs, composes and encodes them, storing the material in the asset named by the required assetName field.
Supports two modes:
- With multiviewComposing: Inputs defined in multiviewComposing config.
- Without multiviewComposing: Inputs defined in encodingLive config using multiInputComposer input type.
Starting a StaticMultiviewChannel flow will immediately charge the full monthly fee to your payment method, no matter how much of the month remains.
Please see StaticMultiviewEvent for encoding billed by the minute.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'multiviewComposing'. If omitted, inputs are taken from encodingLive.
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.
StaticMultiviewEventobjectStaticMultiviewEventFlow
A flow that takes multiple live inputs, composes and encodes them, storing the material in the asset named by the required assetName field.
Supports two modes:
- With multiviewComposing: Inputs defined in multiviewComposing config.
- Without multiviewComposing: Inputs defined in encodingLive config using multiInputComposer input type.
A StaticMultiviewEvent flow is billed by the minute, please see StaticMultiviewChannel for encoding billed by the month.
archiveWindowLengthstringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The maximum content length that can be archived in the asset for the live output. This also limits the maximum content length for the timeshift window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. Max value = 30 days.
assetNamestringRequired
The name of asset that you want this flow to store material in.
assetPathstringOptional
If an asset name is given, then you may also specify a subpath within the asset for the material.
Reference to template of type 'encodingLive'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'multiviewComposing'. If omitted, inputs are taken from encodingLive.
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
Optional reference to template of type 'streamConditioning'
Show 4 propertiesHide 4 properties
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this component.
These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configOverridesobjectOptional
Optional control over template contents. These are applied after any configValues.
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
application/json-patch+jsonobjectFlowJsonPatchOverrides
List of 'JSON Patch' (https://en.wikipedia.org/wiki/JSON_Patch) operations.
Show 4 propertiesHide 4 properties
openumRequired
Operation
Allowed values:addremovereplacestringReplacenumberReplace
pathstringRequired
Path
searchstringOptional
Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".
Value
typestringRequired
Type of override.
Reference to configuration template
Show 2 propertiesHide 2 properties
namestringRequired
Name of the configuration template to use, must match the configType.
versionstringRequired
Which revision of the configuration to use, either a tag or a hash must be provided
Optional control over template contents, replacing parameters exposed by the configuration.
These are applied before any configOverrides.
Show value schemaHide value schema
[any key]any
typestringRequired
Processing type.
Flow status.
Show 11 propertiesHide 11 properties
deviceDisplayNamestringOptional<=255 characters
The display name of the <glossary:device> the flow is assigned to. Empty if not assigned or if the flow is on a <<glossary:SaaS site>>.
deviceNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$Defaults to
The name of the <glossary:device> the flow is assigned to. Empty if not assigned or if the flow is on a <<glossary:SaaS site>>.
infostringOptional
An optional informational message. Only present if not empty.
The status of flow inputs.
Show 10 propertiesHide 10 properties
contentDisplayNamestringOptional<=255 characters
If the flow input references content, this field contains the display name of that <glossary:content>.
If the flow input references a source, this field contains the display name of the <glossary:content> referenced by that source.
If the flow input references a flow, this field contains the display name of the <glossary:content> assigned to the resolved upstream flow output, or empty if resolution failed.
contentNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
If the flow input references content, this field contains the name of that <glossary:content>.
If the flow input references a source, this field contains the name of the <glossary:content> referenced by that source.
If the flow input references a flow, this field contains the name of the <glossary:content> assigned to the resolved upstream flow output, or empty if resolution failed.
deviceInterfaceNamestringOptionalpattern: ^([^\s\/]{1,16}|[a-zA-Z][a-zA-Z0-9_]{1,255})?$
The name of the <<glossary:device interface>> assigned to the flow input. Empty if a device interface is not assigned.
networkDisplayNamestringOptional<=255 characters
The display name of the <glossary:network> assigned to the flow input. Empty if the content was resolved from a directly-connected <glossary:source> (e.g. SDI) or a network is not assigned.
networkNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The name of the <glossary:network> assigned to the flow input. Empty if the content was resolved from a directly-connected <glossary:source> (e.g. SDI) or a network is not assigned.
sourceDisplayNamestringOptional<=255 characters
The display name of the <glossary:source> assigned to the flow input. Empty if the content was resolved to an upstream <glossary:flow> or a source is not assigned.
sourceNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The name of the <glossary:source> assigned to the flow input. Empty if the content was resolved to an upstream <glossary:flow> or a source is not assigned.
sourceShortIdstringOptionalpattern: ^([a-z0-9]{12})?$
An alternative short identifier for the source. This is used only for visual inspection and should not be used for any programmatic purposes.
sourceUrlstring or nullOptional<=2048 characters
The ingress URL for the <glossary:source> assigned to the flow input. Empty if the source does not have a URL.
upstreamFlowNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The name of an upstream <glossary:flow> providing the input. Empty if the content was resolved to a <glossary:source> or if an upstream flow is not assigned.
A dictionary of metrics reported by the flow.The keys are metrics names and the values contains an array of samples for that metric.The Sample contains a 'value' field and a 'labels' field which is a dictionary of label keys and values.
Show value schemaHide value schema
[any key]object
Show 2 propertiesHide 2 properties
labelsmap from strings to stringOptional
A dictionary of label keys and values for this metric sample.
Show value schemaHide value schema
[any key]string
valuedoubleRequired
The value of the metric sample.
Details for how to access monitoring feedback. Each key is a monitoring context that is influenced by the <<glossary:flow transform>> selected in the flow and the configuration of the flow transform. Read flow monitoring to learn more.
Show value schemaHide value schema
[any key]object
Show 2 propertiesHide 2 properties
metadataUrlstringRequired<=2048 characters
URL of the metadata.
thumbnailUrlstringRequired<=2048 characters
URL of the thumbnail image.
The status of flow outputs.
Show 9 propertiesHide 9 properties
contentDisplayNamestringRequired<=255 characters
The display name of the <glossary:content> that is provided by this flow output.
contentNamestringRequiredpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The <glossary:content> that is provided by this flow output.
destinationDisplayNamestringOptional<=255 characters
The display name of the <glossary:destination> reference from the flow output. Empty if this is a <<glossary:internal flow output>> with no destination.
destinationUrlstring or nullOptional<=2048 characters
The egress URL for the <glossary:destination> assigned to the flow output. Empty if the destination does not have a URL.
deviceInterfaceNamestringOptionalpattern: ^([^\s\/]{1,16}|[a-zA-Z][a-zA-Z0-9_]{1,255})?$
The name of the <<glossary:device interface>> assigned to the flow output. Empty if a device interface is not assigned.
downstreamFlowNameslist of stringsOptional
List of names of <glossary:flow>s that are connected to this flow output. Empty if the flow output is not connected to any downstream flows.
networkDisplayNamestringOptional<=255 characters
The display name of the <glossary:network> assigned to the flow outputEmpty if the output references a directly-connected <glossary:destination> (e.g. SDI) or a network is not assigned.
networkNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The name of the <glossary:network> assigned to the flow output. Empty if the output references a directly-connected <glossary:destination> (e.g. SDI) or a network is not assigned.
Transport settings specific to this flow output.
Show 3 propertiesHide 3 properties
latencydoubleOptional
The minimum SRT Latency, in seconds for this output's connections, if known.
maxBitrateintegerRequired
The calculated maximum bitrate for the flow output's transport.
maxConnectionsintegerOptional>=1
The maximum number of connections allowed for this output where a restriction applies.
shortIdstringOptionalpattern: ^([a-z0-9]{12})?$
An alternative short identifier for the flow. This is used only for visual inspection and should not be used for any programmatic purposes.
siteDisplayNamestringOptional<=255 characters
The display name of <glossary:site> associated with the flow.
stateenumOptional
The last reported state of the flow.
Allowed values:StoppingStoppedStartingRunningPendingDeletingDeletedUpdatingStartedAllocatingAllocatedUnableToStart
Show 1 propertyHide 1 property
Show 1 propertyHide 1 property
hostNamestringOptional
Errors
400 Bad Request
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
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
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
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
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
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