List Streaming Locators

Listing, Sorting and Filtering Streaming Locators

This endpoint returns the list of streaming locators in the specified project.

Sorting

The results from this endpoint can be ordered using the $orderby query parameter. Specify a field name, and optionally asc or desc.

Sorting is valid on the following fields: name, properties/created, properties/endTime

Filtering

There are two ways to filter the set of returned streaming locators from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.

$filter allows for streaming locators 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: name, properties/created, properties/endTime

Examples:

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

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

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

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

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

Language
Authorization
Click Try It! to start a request and see the response here!