List Streaming Endpoints

get https://app.mk.io/api/v1/projects/:project_name/media/streamingEndpoints

Listing, Sorting and Filtering Streaming Endpoints

This endpoint returns the list of streaming endpoints 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, id, name, properties/created, properties/description, properties/lastModified, properties/resourceState, properties/scaleUnits, updated, updatedBy

Filtering

The $filter query parameter allows for streaming endpoints 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, id, name, properties/created, properties/description, properties/lastModified, properties/resourceState, properties/scaleUnits, updated, updatedBy, updatedByEmail, updatedByName

Examples:

?$top=10 - Returns only the first 10 streaming endpoints from the list.

?$orderby=name desc - Sorts streaming endpoints by name in descending order.

?$filter=name eq 'descriptive name' - Returns streaming endpoints that match the provided name.

?$orderby=created desc - Sorts streaming endpoints by creation date in descending order.

?$filter=created ge 2021-01-01T00:00:00Z - Returns streaming endpoints created after January 1, 2021.

?$filter=properties/resourceState eq 'Running' - Returns streaming endpoints in the Running state.

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.

Response

200 A list of Streaming Endpoints.
@odata.nextLinkstringOptional
@odata.nextLink URL if the page length and number of items match.
supplementalobjectListResponseSupplementalSchemaRequired
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'
paginationobjectPaginationInfoSchemaRequired
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
subscriptionobjectProjectInfoSchemaOptional
Project info
Show 2 propertiesHide 2 properties
idstringRequired
Project ID
namestringRequired
Project name
valuelist of objectsStreamingEndpointSchemaRequired
A list of streaming endpoints
Show 4 propertiesHide 4 properties
locationstringRequired
The name of the location in which the streaming endpoint is located. This field must match the location in which the user's subscription is provisioned.
namestringOptional1-64 characterspattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
The name of the resource
propertiesobjectStreamingEndpointPropertiesRequired
The properties of the streaming endpoint.
Show 21 propertiesHide 21 properties
accessControlobjectStreamingEndpointAccessControlOptional
The access control settings for the streaming endpoint.
Show 2 propertiesHide 2 properties
akamaiobjectStreamingEndpointAkamiACLOptionalDeprecated
DEPRECATED: This is provided for backwards compatibility and will be removed in a future release. Akamai access control configuration for the streaming endpoint. If the Akamai CDN profile is specified and CDN is enabled, this field is required.
Show 1 propertyHide 1 property
akamaiSignatureHeaderAuthenticationKeyListlist of objectsAkamiHeaderAuthKeyRequiredDeprecated
DEPRECATED: This is provided for backwards compatibility and will be removed in a future release. The Akamai access control configuration for the streaming endpoint. Learn more: https://techdocs.akamai.com/netstorage-usage/reference/example-authentication-headers
Show 3 propertiesHide 3 properties
base64KeystringOptional
expirationstringOptional
identifierstringOptional
ipobjectStreamingEndpointIPACLOptional
IP-based access control configuration for the streaming endpoint. If omitted, this will default to 0.0.0.0/0
Show 1 propertyHide 1 property
allowlist of objectsIPAclRequired
The IP allow list.
Show 3 propertiesHide 3 properties
addressstringRequired
namestringOptionalDefaults to
The name of the IP ACL.
subnetPrefixLengthintegerOptional0 to 32Defaults to 32
The subnet prefix length (see CIDR notation).
advancedSettingsNamestring or nullOptional<=64 characters
Name of the advanced settings configuration to apply to this streaming endpoint. These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
cdnBasePathstringOptional
If CDN is enabled, the path that must be inserted after the hostname and before the locator, e.g. https://.
cdnEnabledbooleanOptionalDefaults to false
Indicates if CDN is enabled for the streaming endpoint.
cdnProfilestringOptional<=100 characters
If CDN is enabled, the optional CDN profile name for the streaming endpoint.
cdnProviderenumOptionalDeprecated
DEPRECATED: CDN provider is set by default when CDN is enabled. Value will be ignored if provided. This is provided for backwards compatibility and will be removed in a future release.
Allowed values:StandardAkamai
createdstringOptionalformat: date-time
The creation date and time of the streaming endpoint. Set by the system.
crossSiteAccessPoliciesobjectCrossSiteAccessPoliciesOptional
Cross-site access policies are CDN policies for Smooth or DASH streaming that determine which domains clients are permitted to playback content from.
Show 2 propertiesHide 2 properties
clientAccessPolicystring or nullOptional
The XML content of the client access policy file. Search 'clientaccesspolicy.xml' to learn more.
crossDomainPolicystring or nullOptional
The XML content of the cross-domain policy file. Search 'crossdomain.xml' to learn more.
customHostNameslist of stringsOptional
NOT SUPPORTED pending implementation of DNS validation. Custom host names for the streaming endpoint. Must be unique within the region. If not specified, a default hostname will be used. The best practice for custom DNS is to use a CNAME pointing to the autogenerated hostname derived from the streaming endpoint name, and to configure your CDN to deliver a HOST header to the origin server for routing purposes.
descriptionstring or nullOptional<=1024 characters
The description of the streaming endpoint.
hostNamestringOptional
The fqdn of the streaming endpoint. This is the output hostname and is always configured. To set a custom hostname, use the customHostNames property.
lastModifiedstringOptionalformat: date-time
The last modified date and time of the streaming endpoint. Set by the system.
maxCacheAgeintegerOptional0 to 2592000Defaults to 86400
The maximum amount of time that segments will be cached, in seconds. This value is superseded by any ETAG values set by the infrastructure.
maxManifestCacheAgeintegerOptional0 to 2592000Defaults to 60
The maximum amount of time that closed manifests will be cached, in seconds. This value is superseded by any ETAG values set by the infrastructure.
provisioningStateenumOptional
The provisioning state of the streaming endpoint. Set by the system. One of InProgress,Succeeded,Failed.
Allowed values:InProgressSucceededFailed
publicNamestringOptional3-63 characterspattern: ^[a-z0-9]+(-[a-z0-9]+)*$
Public name for the streaming endpoint
resourceStateenumOptional
The runtime state of the streaming endpoint. Set by the system.
Allowed values:CreatingUpdatingScalingStartingStoppingRestartingDeletingRunningStoppedDeleted
scaleUnitsintegerRequired>=0
The number of scale units for the streaming endpoint. This will determine your minimum scale. A value of 0 will result in the streaming endpoints using a Standard SKU. A value greater than zero indicates that the 'Premium' SKUs will be provisioned.
shieldCacheobjectStreamingEndpointShieldCacheOptional
Shield cache configuration for the streaming endpoint.
Show 1 propertyHide 1 property
scaleUnitsinteger or nullRequired0 to 1024
The number of scale units for the shield cache. A value of 0 indicates that no shield cache will be deployed. This feature should only be used if advised by MediaKind. It is controlled by a feature flag.
skuobjectStreamingEndpointsCurrentSkuOptional
The SKU definition for the streaming endpoint.
Show 2 propertiesHide 2 properties
capacityintegerOptional
This is the bandwidth capacity of current streaming unit configuration
nameenumRequired
The name of the SKU. Will default to 'Standard' if the sku configuration is not provided.
Allowed values:StandardPremium
urlStylestringOptional
The style of URL associated with the streaming endpoint. The default is 'AMS' and you should only use any other value if advised to by MediaKind
tagsmap from strings to stringOptional
A dictionary of key:value pairs describing the resource. Search may be implemented against tags in the future.
Show value schemaHide value schema
[any key]string

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