List available AI Models

Retrieves the set of available models.

List available AI Pipelines

Retrieves a list of AI pipelines for the specified project.

Get an AI pipeline

Returns the current version of the pipeline

Create a new AI Pipeline

This creates a new AI Pipeline

Delete an AI pipeline

Delete a pipeline, no running instance of that pipeline needs to be executing

List Storage Accounts

# Storage Accounts The Storage Accounts API provides a means of defining and retrieving Storage Accounts, and associating and managing Storage Credentials for a Storage Account. A Storage Account is a requirement to perform any meaningful activity within this platform. One of the foundational tenets of our product is that the customer owns their content. All content is read from and written to a Storage Account in your own cloud subscription. Storage Accounts are immutable - once created, they cannot be changed. However, you can create new Storage Accounts and delete old ones.

Create a Storage Account

Create Storage Account. The Storage Account must be in the same location as your subscription. The SAS token in the `spec.azureStorageConfiguration.url` field will be used to create a related Storage Credential object for you.

Get Storage Account

Returns details on a single Storage Account

Update Storage Account

Update a Storage Account. Only the description and privateLinkServiceConnection details are updatable.

Delete Storage Account

Deletes our record of your Storage Account. This operation does not delete the Storage Account itself. This operation will not complete successfully if any assets are associated with the Storage Account.

List Storage Credentials

Returns a list of Storage Credentials

Create Storage Credential

Creates a Storage Credential. You can add as many Storage Credentials as you like to a Storage Account. We will choose the Storage Credential with the longest expiry time when we need to access the Storage Account. Credentials are immutable once created - create a new Storage Credential record, then delete the old one, to change a Storage Credential.

Get Storage Credential

Returns a single Storage Credential. Any secret data will be sanitized in the response.

Delete Storage Credential

Removes a Storage Credential from the Storage Account. If the Storage Credential is in use and no alternative Storage Credentials are available, the Storage Account will be inaccessible.

List Account Filters

## Listing, Sorting and Filtering Account Filters This endpoint returns the list of account filters 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` ### Filtering There are two ways to filter the set of returned account filters 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 account filters to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name` ### Examples: `?$top=10` - Returns only the first 10 account filters from the list. `?$orderby=name desc` - Sorts account filters by name in descending order. `?$filter=name eq 'descriptive name'` - Returns account filters that match the provided name.

Get Account filter

Get an account filter by name.

Create or Update Account Filter

Create or Update Account Filter.

Delete Account Filter

Delete Account Filter. Account filters can only be removed when they are not referenced by any active streaming locators.

List Assets

## Listing, Sorting and Filtering Assets This endpoint returns the list of assets 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/alternateId`, `properties/assetId`, `properties/created` ### Filtering There are two ways to filter the set of returned assets 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 assets to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/alternateId`, `properties/assetId`, `properties/created` `$label_key` and `$label` are specific to querying assets based on their labels. Labels are a set of key-value pairs that can be used to identify assets with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of assets. ### Examples: `?$top=10` - Returns only the first 10 assets from the list. `?$orderby=name desc` - Sorts assets by name in descending order. `?$filter=name eq 'descriptive name'` - Returns assets that match the provided name. `?$orderby=properties/created desc` - Sorts assets by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns assets created after January 1, 2021. `?$label=studio=paravalley` - Returns assets with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns assets with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns assets with any value set for the `studio` label and the `release-date` label.

Get Asset

Get an asset by name.

Create or Update Asset

Create or Update Asset. When creating an asset, that asset needs to have a unique container & storage account within the project. When updating an asset, only the description column can be updated.

Delete Asset

Delete Asset. When you delete an asset, the underlying storage container will be deleted too. You can control this behavior by assigning a DeletionPolicy to your asset.

List Asset Filters

## Listing, Sorting and Filtering Asset Filters This endpoint returns the list of asset filters 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` ### Filtering There are two ways to filter the set of returned asset filters 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 asset filters to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name` ### Examples: `?$top=10` - Returns only the first 10 asset filters from the list. `?$orderby=name desc` - Sorts asset filters by name in descending order. `?$filter=name eq 'descriptive name'` - Returns asset filters that match the provided name.

Get Asset Filter

Get an asset filter by name.

Create or Update Asset Filter

Create or Update Asset Filter.

Delete Asset Filter

Delete Asset Filter. Asset filters can only be removed when they are not referenced by any active streaming locators.

List Streaming Locators

List Streaming Locators for Asset. This API call is a convenience method to retrieve any and all playback configurations, or StreamingLocators, that are associated with this asset.

Retrieve tracks.

The Azure Storage Data Retrieval API is designed to provide restricted information about data stored in Azure Storage containers. This API allows users to interact with data in a secure and efficient manner, without directly altering the stored data. Here are key features and purposes of this API: List Container Contents: It enumerates the contents of an Azure Storage container. This operation returns both files and folders within the specified container, enabling users to navigate through the hierarchical data structure. View Track Listings: This API will generate available track listings for any media files contained within the specified container. Track listings are inclusive of video, audio, and text tracks. If available, the API will also return the track's language and bitrate. Security: This API is scoped only to the configured storage account and is only accessible to users who have access to the subscription in which the asset resides. It is a readonly API that does not allow for any mutation or creation operations, and which cannot be used to retrieve any data from the storage account.

List Content Key Policies

## Listing, Sorting and Filtering Content Key Policies This endpoint returns the list of content key policies 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/description`, `properties/lastModified`, `properties/policyId` ### Filtering There are two ways to filter the set of returned content key policies 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 content key policies to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/created`, `properties/description`, `properties/lastModified`, `properties/policyId` ### Examples: `?$top=10` - Returns only the first 10 content key policies from the list. `?$orderby=name desc` - Sorts content key policies by name in descending order. `?$filter=name eq 'descriptive name'` - Returns content key policies that match the provided name. `?$orderby=properties/created desc` - Sorts content key policies by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns content key policies created after January 1, 2021.

Get

Get one Content Key Policy

Create

Create a Content Key Policy

Update

Update an existing Content Key Policy.

Delete

Delete a Content Key Policy. If the policy does not exist, this will return a 204.

Get Secrets

Get a Content Key Policy including secret values

List Jobs

## Listing, Sorting and Filtering Jobs This endpoint returns the list of jobs 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/state`, `properties/created`, `properties/lastModified` ### Filtering There are two ways to filter the set of returned jobs 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 jobs to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/state`, `properties/created`, `properties/lastModified` ### Examples: `?$top=10` - Returns only the first 10 jobs from the list. `?$orderby=name desc` - Sorts jobs by name in descending order. `?$filter=name eq 'descriptive name'` - Returns jobs that match the provided name. `?$orderby=properties/created desc` - Sorts jobs by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns jobs created after January 1, 2021.

List Live Events

## 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 field name, and optionally `asc` or `desc`. Sorting is valid on the following fields: `name`, `properties/created`, `properties/description`, `properties/lastModified` ### 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. `$filter` allows for live events to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/created`, `properties/description`, `properties/lastModified` ### 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=properties/created desc` - Sorts live events by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns live events created after January 1, 2021.

Retrieve a live event

Returns a live event.

Create a live event

Update a Live Event

NOT IMPLEMENTED. Update a live event

Delete a Live Event

Delete a live event.

Allocate a Live Event

NOT IMPLEMENTED. Allocates resources for a Live Event. A live event is in StandBy state after allocation completes, and is ready to start.

List Live Outputs

## Listing, Sorting and Filtering Live Outputs This endpoint returns the list of live outputs 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/description`, `properties/lastModified` ### Filtering There are two ways to filter the set of returned live outputs 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 live outputs to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/created`, `properties/description`, `properties/lastModified` ### Examples: `?$top=10` - Returns only the first 10 live outputs from the list. `?$orderby=name desc` - Sorts live outputs by name in descending order. `?$filter=name eq 'descriptive name'` - Returns live outputs that match the provided name. `?$orderby=properties/created desc` - Sorts live outputs by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns live outputs created after January 1, 2021.

Get

Returns a single Live Output.

Create

Creates a Live Output

Delete

Deletes a Live Output. If the Live Output is not found, a 204 is returned.

Reset a Live Event

NOT IMPLEMENTED. Resets a Live Event. All live outputs for the live event are deleted and the live event is stopped and will be started again.

Start a Live Event

Start a Live Event. This operation transitions your Live Event into a running state

Stop a Live Event

Stops a Live Event. Any active playback sessions will be interrupted.

List Streaming Endpoints

## 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 field name, and optionally `asc` or `desc`. Sorting is valid on the following fields: `name`, `properties/created`, `properties/description`, `properties/lastModified` ### Filtering There are two ways to filter the set of returned streaming endpoints 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 endpoints to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/created`, `properties/description`, `properties/lastModified` ### 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=properties/created desc` - Sorts streaming endpoints by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns streaming endpoints created after January 1, 2021.

Get Streaming Endpoint

Retrieves a single Streaming Endpoint.

Create Streaming Endpoint

Create a Streaming Endpoint.

Update Streaming Endpoint

Update a Streaming Endpoint. Only the Name and cdnProvider fields are immutable.

Delete Streaming Endpoint

Delete a Streaming Endpoint. If the Streaming Endpoint does not exist, this API will return a 204.

Scale Streaming Endpoint

Changes the scale of the Streaming Endpoint.

List Streaming Endpoint SKUs

This API is not implemented.

Start Streaming Endpoint

Start a Streaming Endpoint. This operation transitions your Streaming Endpoint into a running state.

Stop Streaming Endpoint

Stop a Streaming Endpoint. Any active playback sessions will be interrupted.

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](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) 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.

Get Streaming Locator

Returns a single Streaming Locator for a given project.

Create Streaming Locator

Creates a Streaming Locator.

Delete Streaming Locator

Deletes the Streaming Locator. If the Streaming Locator does not exist, a 204 is returned same as if it does. Once the Streaming Locator is deleted, all future requests to the path owned by the Streaming Locator will fail. If content is cached in a CDN, playback may continue to work for some time until the cached content expires.

List Content Keys

List Content Keys used by this Streaming Locator

List URL paths

ListPaths returns the set of valid streaming paths for a given Streaming Locator. A distinct set of paths is returned for each type of DRM configured, per the 'EnabledProtocols' property of the streaming policy.

List Streaming Policies

## Listing, Sorting and Filtering Streaming Policies This endpoint returns the list of streaming policies 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` ### Filtering There are two ways to filter the set of returned streaming policies 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 policies to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/created` ### Examples: `?$top=10` - Returns only the first 10 streaming policies from the list. `?$orderby=name desc` - Sorts streaming policies by name in descending order. `?$filter=name eq 'descriptive name'` - Returns streaming policies that match the provided name. `?$orderby=properties/created desc` - Sorts streaming policies by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns streaming policies created after January 1, 2021. ## Note that the default policies will always appear in the results

Get

Get one Streaming Policy

Create

Create a Streaming Policy

Delete

Delete a Streaming Policy. If the policy does not exist, this will return a 204.

List Transforms

## Listing, Sorting and Filtering Transforms This endpoint returns the list of transforms 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/lastModified` ### Filtering There are two ways to filter the set of returned transforms 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 transforms to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `name`, `properties/created`, `properties/lastModified` ### Examples: `?$top=10` - Returns only the first 10 transforms from the list. `?$orderby=name desc` - Sorts transforms by name in descending order. `?$filter=name eq 'descriptive name'` - Returns transforms that match the provided name. `?$orderby=properties/created desc` - Sorts transforms by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns transforms created after January 1, 2021.

Get Transform

Get a transform by name.

Create or Update Transform

Create or Updates a new Transform.

Delete a Transform

Delete a Transform.

List Jobs

Retrieves a list of Jobs for a Transform.

Get Job

Get an transform by name.

Create a Job

Create a new Job.

Update a Job

Update an existing Job. Update is only supported for `description` and `priority`.

Delete a Job

Delete a Job.

Cancel a Job

Cancel an already running Job.

Get public keys

Get all currently valid public keys in JWKS format. The key ID (`kid`) in the JWT headers should match a `kid` in this list.

Get revoked token IDs

Get a list of revoked token IDs. These will be the ID values found in the `jti` property of the decoded JWT. If the `jti` value matches one of the IDs in the returned list then it should be considered as revoked and treated as invalid.

Get profile

This endpoint returns the details of the current user.

Update profile

This endpoint allows certain fields within the profile to be updated.

Get an organization

Returns your active organization.

Update organization

Update your organization details.

List pending invites

This endpoint shows the current list of invitations that have been sent by this MK.IO organization and which have not been accepted or declined yet.

Create an invite

This endpoint allows you to create a new invitation which will grant a user access to this organization's resources within MK.IO. You can include a comment which will be visible against this user's record when they accept the invitation, e.g. "Contractor for project Delphi".

Get one pending invite

This endpoint shows the details of one pending invitation.

Cancel pending invite

This endpoint allows you to remove a pending invitation if you change your mind, or if the invitation is wrong.

List Roles

Returns details of all Roles.

Get a Role

Returns details of a single Role.

List Scopes

Returns details of all Scopes.

Get a Scope

Returns details of a single Scope.

List Teams

Returns details of all Teams.

Get a Team

Returns details of a single Team

Create or Edit a Team

Create a new team with a unique name, or Edit an existing team.

Patch a Team

Modify a team using a JSON patch format document

Delete a Team

Delete the team, including all of its rights. This will not remove users from your organization.

Get tokens of all users

Get a list of all tokens that provide access to this MK.IO organization. Expired tokens will not be listed.

Revoke a token of a user

Revoke a token by its ID. The ID is the value of the decoded token's `jti` property. The token can belong to any user with access to this MK.IO organization.

List users

This endpoint shows the details of all users with access to this organization in MK.IO.

Get user details

This endpoint shows the details of one user.

Remove user

This endpoint allows you to remove a user's access to your organization in MK.IO. Removing the user will remove the user from all teams in the organization. If the user is registered in the SSO provider for this organization and logs in again they will be re-added to the organization but any specific team memberships will not be re-created.

List projects

Returns the current list of projects within this organization.

Get a project

Returns a specified project.

Get metrics

Returns the metrics endpoint for a specified project.

Update metrics

Enable or disable metrics for a specified project.

List user's organizations and any associated invitation

This endpoint return a list of organizations that the user has access to, or is invited to.

Get organization details

Get one organization name and state

Update organization details (to accept an invitation).

The only field that can be modified is the invite state, and that should be set to 'accepted' to accept a 'pending' invitation to work with a new organization. To decline a pending invitation, use the DELETE method instead.

Leave an organization/Decline an invite to an organization

This endpoint allows the current user to remove their access to a particular MK.IO organization. This operation can only be reversed by accepting a new invitation from that organization. If you are still not part of that organization but have a pending invite for it, this endpoint would decline that invitation.

Get profile

This endpoint returns the details of the current user.

Update profile

This endpoint allows certain fields within the profile to be updated.

Get RBAC capability data

This endpoint returns your RBAC capabilities. Please see our online documentation for more details on the format of this data.

Get all user tokens

Get all non-expired API tokens issued to the current user.

Request a new token

Request a new token granting access to the MK.IO API. There are three types of tokens. - 'restricted' tokens can have an `expireDate` set to up to a year in the future grant a reduced set of capabilities. Please see our online documentation for a description of how the capabilities are defined. - 'login' tokens are short-lived and grant the full user capabilities. - 'full-access' tokens can have an `expireDate` set to up to a year in the future and grant the full user capabilities. Where possible you should prefer 'restricted' tokens over 'full-access' tokens to reduce the impact if one is exposed accidentally. An API token allows access to MK.IO to anyone who has a copy of it - you should treat these like your car keys and keep them safe.

Revoke all user tokens

Completely logout of the api by revoking all the tokens of the current user, for all organizations

Get a user token by ID

Get a user token by ID.

Revoke a token

Revoke a token by its ID. The ID is the value of the decoded token's `jti` property.

List Devices

## Listing, Sorting and Filtering Devices This endpoint returns the list of devices 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: `metadata/name`, `spec/softwareVersion`, `spec/site`, `status/model`, `status/serialNumber`, `status/currentSoftwareVersion`, `status/lastContact`, `status/alarmSeverity` ### Filtering There are two ways to filter the set of returned devices 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 devices to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name`, `spec/softwareVersion`, `spec/site`, `status/model`, `status/serialNumber`, `status/currentSoftwareVersion`, `status/lastContact`, `status/alarmSeverity` `$label_key` and `$label` are specific to querying devices based on their labels. Labels are a set of key-value pairs that can be used to identify devices with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of devices. ### Examples: `?$top=10` - Returns only the first 10 devices from the list. `?$orderby=name desc` - Sorts devices by name in descending order. `?$filter=name eq 'descriptive name'` - Returns devices that match the provided name. `?$orderby=properties/created desc` - Sorts devices by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns devices created after January 1, 2021. `?$label=studio=paravalley` - Returns devices with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns devices with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns devices with any value set for the `studio` label and the `release-date` label.

Get Device

Retrieves a single Device.

Create Device

Create a Device.

Update Device

Update a Device

Delete Device

Delete a Device. If the Device does not exist, this API will return a 204.

List of content

## Listing, Sorting and Filtering Content This endpoint returns the list of content 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: `metadata/name` ### Filtering There are two ways to filter the set of returned content 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 content to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name` `$label_key` and `$label` are specific to querying content based on their labels. Labels are a set of key-value pairs that can be used to identify content with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of content. ### Examples: `?$top=10` - Returns only the first 10 content from the list. `?$orderby=name desc` - Sorts content by name in descending order. `?$filter=name eq 'descriptive name'` - Returns content that match the provided name. `?$orderby=properties/created desc` - Sorts content by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns content created after January 1, 2021. `?$label=studio=paravalley` - Returns content with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns content with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns content with any value set for the `studio` label and the `release-date` label.

Get Content

Retrieves the settings for a single piece of Content.

Create Content

Create a piece of content.

Update Content

Update a piece of Content

Delete Content

Delete a piece of Content. If the Content does not exist, this API will return a 204.

List of destinations

## Listing, Sorting and Filtering Destinations This endpoint returns the list of destinations 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: `metadata/name`, `spec/transport/type` ### Filtering There are two ways to filter the set of returned destinations 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 destinations to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name`, `spec/transport/type` `$label_key` and `$label` are specific to querying destinations based on their labels. Labels are a set of key-value pairs that can be used to identify destinations with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of destinations. ### Examples: `?$top=10` - Returns only the first 10 destinations from the list. `?$orderby=name desc` - Sorts destinations by name in descending order. `?$filter=name eq 'descriptive name'` - Returns destinations that match the provided name. `?$orderby=properties/created desc` - Sorts destinations by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns destinations created after January 1, 2021. `?$label=studio=paravalley` - Returns destinations with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns destinations with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns destinations with any value set for the `studio` label and the `release-date` label.

Get Destination

Retrieves a single Destination.

Create Destination

Create a Destination.

Update Destination

Update a Destination

Delete Destination

Delete a Destination. If the Destination does not exist, this API will return a 204.

List Flows

## Listing, Sorting and Filtering Flows This endpoint returns the list of flows 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: `metadata/name`, `spec/site`, `spec/mode`, `status/assignedDevice`, `spec/outputs/destination`, `spec/inputs/content` ### Filtering There are two ways to filter the set of returned flows 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 flows to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name`, `spec/site`, `spec/mode`, `status/assignedDevice`, `spec/outputs/destination`, `spec/inputs/content` `$label_key` and `$label` are specific to querying flows based on their labels. Labels are a set of key-value pairs that can be used to identify flows with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of flows. ### Examples: `?$top=10` - Returns only the first 10 flows from the list. `?$orderby=name desc` - Sorts flows by name in descending order. `?$filter=name eq 'descriptive name'` - Returns flows that match the provided name. `?$orderby=properties/created desc` - Sorts flows by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns flows created after January 1, 2021. `?$label=studio=paravalley` - Returns flows with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns flows with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns flows with any value set for the `studio` label and the `release-date` label.

Get Flow

Retrieves a single Flow.

Create Flow

Create a Flow.

Update Flow

Update a Flow

Delete Flow

Delete a Flow. If the Flow does not exist, this API will return a 204.

List Sources

## Listing, Sorting and Filtering Sources This endpoint returns the list of sources 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: `metadata/name`, `spec/transport/type`, `spec/content` ### Filtering There are two ways to filter the set of returned sources 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 sources to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name`, `spec/transport/type`, `spec/content` `$label_key` and `$label` are specific to querying sources based on their labels. Labels are a set of key-value pairs that can be used to identify sources with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of sources. ### Examples: `?$top=10` - Returns only the first 10 sources from the list. `?$orderby=name desc` - Sorts sources by name in descending order. `?$filter=name eq 'descriptive name'` - Returns sources that match the provided name. `?$orderby=properties/created desc` - Sorts sources by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns sources created after January 1, 2021. `?$label=studio=paravalley` - Returns sources with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns sources with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns sources with any value set for the `studio` label and the `release-date` label.

Get Source

Retrieves a single Source.

Create Source

Create a Source.

Update Source

Update a Source

Delete Source

Delete a Source. If the Source does not exist, this API will return a 204.

List of transforms

## Listing, Sorting and Filtering Transform This endpoint returns the list of transform 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: `metadata/name` ### Filtering There are two ways to filter the set of returned transform 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 transform to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name` `$label_key` and `$label` are specific to querying transform based on their labels. Labels are a set of key-value pairs that can be used to identify transform with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of transform. ### Examples: `?$top=10` - Returns only the first 10 transform from the list. `?$orderby=name desc` - Sorts transform by name in descending order. `?$filter=name eq 'descriptive name'` - Returns transform that match the provided name. `?$orderby=properties/created desc` - Sorts transform by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns transform created after January 1, 2021. `?$label=studio=paravalley` - Returns transform with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns transform with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns transform with any value set for the `studio` label and the `release-date` label.

Get Transform

Retrieves a single Transform.

Create Transform

Create a Transform.

Delete Transform

Delete a Transform. If the Transform does not exist, this API will return a 204.

List Networks

## Listing, Sorting and Filtering Networks This endpoint returns the list of networks 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: `metadata/name`, `status/automatic` ### Filtering There are two ways to filter the set of returned networks 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 networks to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name`, `status/automatic` `$label_key` and `$label` are specific to querying networks based on their labels. Labels are a set of key-value pairs that can be used to identify networks with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of networks. ### Examples: `?$top=10` - Returns only the first 10 networks from the list. `?$orderby=name desc` - Sorts networks by name in descending order. `?$filter=name eq 'descriptive name'` - Returns networks that match the provided name. `?$orderby=properties/created desc` - Sorts networks by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns networks created after January 1, 2021. `?$label=studio=paravalley` - Returns networks with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns networks with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns networks with any value set for the `studio` label and the `release-date` label.

Get Network

Retrieves a single Network.

Create Network

Create a Network.

Update Network

Update a Network

Delete Network

Delete a Network. If the Network does not exist, this API will return a 204.

List Sites

## Listing, Sorting and Filtering Sites This endpoint returns the list of sites 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: `metadata/name` ### Filtering There are two ways to filter the set of returned sites 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 sites to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `metadata/name` `$label_key` and `$label` are specific to querying sites based on their labels. Labels are a set of key-value pairs that can be used to identify sites with any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of sites. ### Examples: `?$top=10` - Returns only the first 10 sites from the list. `?$orderby=name desc` - Sorts sites by name in descending order. `?$filter=name eq 'descriptive name'` - Returns sites that match the provided name. `?$orderby=properties/created desc` - Sorts sites by creation date in descending order. `?$filter=properties/created ge 2021-01-01T00:00:00Z` - Returns sites created after January 1, 2021. `?$label=studio=paravalley` - Returns sites with the label `studio` set to `paravalley`. `?$label=release-date~2023` - Returns sites with the label `release-date` set to a value that contains `2023`. `?$label_key=studio&label_key=release-date` - Returns sites with any value set for the `studio` label and the `release-date` label.

Get Site

Retrieves a single Site.

Create Site

Create a Site.

Update Site

Update a Site

Delete Site

Delete a Site. If the Site does not exist, this API will return a 204.