List alerts associated with an account

- channelId: ID of the channel. String of maximum length 32 characters - alerts: Collection containing the specific alert details

List channels associated with an account

Retrieves a list of all channels associated with this account. Each Channel has the form: - id: Must be unique amongst other channels for this account. Maximum length of 32 characters. Only alphanumeric lowercase, non-special characters allowed - name: Must be unique amongst other channels for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed - type: Type of channel (OTT or broadcast) - template: Template from the supported channel templates. - activeSource: The source in use by the encode. 0 - main, 1 - backup - instances: An array, where each entry is a sub-channel instance. These represent redundant replicas of the channel, used to provide High Availability. For a non-HA channel, a single `instance` entry will suffice. - id: Must be unique amongst this channel's instances - outputSuppressionMode: One of: allow, suppress, auto. - sources: An array, where the first entry configures the main source. The second (if present) configures the backup. - id: Must be unique amongst this channel's sources - sourceId: The ID of the source to use as input to this channel - programNumber: The program number if the source is MPTS - status: Contains status information relating to the channel (read only) - instances: An array, where each entry contains status information relating to a sub-channel instance - id: The ID of the corresponding instance (from .instances) - region: The region where this channel is deployed. Only available when the channel is started - state: The current activation state of the instance. One of: stopped, start_requested, infra_creating, starting, started, stop_requested, stopping, start_error - timeStateLastChanged: The last time that this instance changed state - activeSource: The active source for this instance The following parameters are specific to OTT channels: - timeshiftDuration: Timeshift buffer duration in hours - publishPoint: The publish point URL of this channel. Only available when the channel is started The following parameters are specific to broadcast channels: - statmuxPoolId: ID of the statmux pool to be used for this channel - minVideoBitrate: Minimum video bitrate for statmuxing - maxVideoBitrate: Maximum video bitrate for statmuxing Deprecated configuration, moved under .instances: - source: ID of the source to be used as input to this channel - programNumber: Program number if input is MPTS - backupSource: ID of the source to use as backup - backupProgramNumber: Program number if backup is MPTS Deprecated configuration, no longer used: - monitor Deprecated status, moved under .status.instances: - region: The region where this channel is deployed. Only available when the channel is started - state: The current activation state of the channel. One of: stopped, start_requested, infra_creating, starting, started, stop_requested, stopping, start_error - timeStateLastChanged: The last time that this channel changed state

Create a new channel for an account.

Creates a new channel for this accountId - fields required are: - id: Optional. Must be unique amongst other channels for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - name: Must be unique amongst other channels for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. - template: ID of the template from the supported channel templates. Must match an existing Template ID. Channel type is inferred from template type. - instances: An array, where each entry is a sub-channel instance. These represent redundant replicas of the channel, used to provide High Availability. For a non-HA channel, a single `instance` entry will suffice. - id: Must be unique amongst this channel's instances. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - outputSuppressionMode: One of: allow, suppress, auto. - sources: An array, where the first entry configures the main source. The second (if present) configures the backup. - id: Must be unique amongst this channel's sources. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - sourceId: The ID of the source to use as input to this channel - programNumber: The program number if the source is MPTS The following parameters are specific to OTT channels: - timeshiftDuration: Timeshift buffer duration in hours - publishPoint: Optional. Folder included in default output URL path. Defaults to channel name. Max of 32 characters. Only alphanumeric non-special characters allowed The following parameters are specific to broadcast channels: - statmuxPoolId: ID of the statmux pool to be used for this channel - minVideoBitrate: Minimum video bitrate for statmuxing - maxVideoBitrate: Maximum video bitrate for statmuxing Deprecated configuration, moved under .instances: - source: ID of the source to be used as input to this channel - programNumber: Program number if input is MPTS - backupSource: ID of the source to use as backup - backupProgramNumber: Program number if backup is MPTS

List a stored channel of an account

Retrieve the configuration for the specified channel. Each channel has the form: - id: Must be unique amongst other channels for this account. Maximum length of 32 characters. Only alphanumeric lowercase, non-special characters allowed - name: Must be unique amongst other channels for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed - type: Type of channel (OTT or broadcast) - template: Template from the supported channel templates. - activeSource: The source in use by the encode. 0 - main, 1 - backup - instances: An array, where each entry is a sub-channel instance. These represent redundant replicas of the channel, used to provide High Availability. For a non-HA channel, a single `instance` entry will suffice. - id: Must be unique amongst this channel's instances - outputSuppressionMode: One of: allow, suppress, auto. - sources: An array, where the first entry configures the main source. The second (if present) configures the backup. - id: Must be unique amongst this channel's sources - sourceId: The ID of the source to use as input to this channel - programNumber: The program number if the source is MPTS - status: Contains status information relating to the channel (read only) - instances: An array, where each entry contains status information relating to a sub-channel instance - id: The ID of the corresponding instance (from .instances) - region: The region where this channel is deployed. Only available when the channel is started - state: The current activation state of the instance. One of: stopped, start_requested, infra_creating, starting, started, stop_requested, stopping, start_error - timeStateLastChanged: The last time that this instance changed state - activeSource: The active source for this instance The following parameters are specific to OTT channels: - timeshiftDuration: Timeshift buffer duration in hours - publishPoint: The publish point URL of this channel. Only available when the channel is started The following parameters are specific to broadcast channels: - statmuxPoolId: ID of the statmux pool to be used for this channel - minVideoBitrate: Minimum video bitrate for statmuxing - maxVideoBitrate: Maximum video bitrate for statmuxing Deprecated configuration, moved under .instances: - source: ID of the source to be used as input to this channel - programNumber: Program number if input is MPTS - backupSource: ID of the source to use as backup - backupProgramNumber: Program number if backup is MPTS Deprecated configuration, no longer used: - monitor Deprecated status, moved under .status.instances: - region: The region where this channel is deployed. Only available when the channel is started - state: The current activation state of the channel. One of: stopped, start_requested, infra_creating, starting, started, stop_requested, stopping, start_error - timeStateLastChanged: The last time that this channel changed state

Update a channel of an account

Updates the channel for this account specified by the channelId. Takes a document of the form: - id: Optional. Must be unique amongst other channels for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed. Must match the ID being updated - name: Must be unique amongst other channels for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed - template: ID of the template from the supported channel templates. Must match an existing Template ID. Channel type is inferred from template type. - instances: An array, where each entry is a sub-channel instance. These represent redundant replicas of the channel, used to provide High Availability. For a non-HA channel, a single `instance` entry will suffice. - id: Must be unique amongst this channel's instances. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - sources: An array, where the first entry configures the main source. The second (if present) configures the backup. - id: Must be unique amongst this channel's sources. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - sourceId: The ID of the source to use as input to this channel - programNumber: The program number if the source is MPTS The following parameters are specific to OTT channels: - timeshiftDuration: Timeshift buffer duration in hours - publishPoint: Optional. Folder included in default output URL path. Defaults to channel name. Max of 32 characters. Only alphanumeric non-special characters allowed The following parameters are specific to broadcast channels: - statmuxPoolId: ID of the statmux pool to be used for this channel - minVideoBitrate: Minimum video bitrate for statmuxing - maxVideoBitrate: Maximum video bitrate for statmuxing Deprecated configuration, moved under .instances: - source: ID of the source to be used as input to this channel - programNumber: Program number if input is MPTS - backupSource: ID of the source to use as backup - backupProgramNumber: Program number if backup is MPTS Can only be executed when a channel is not in an activated state

Patch a channel a runtime

Updates the channel for this account specified by the channelId. Takes a document of the form: - id: Optional. Must be unique amongst other channels for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed. Must match the ID of the channel being updated - instances: An array, where each entry is a sub-channel instance. These represent redundant replicas of the channel, used to provide High Availability. For a non-HA channel, a single `instance` entry will suffice. - id: Required. Must be unique amongst this channel's instances. Max of 32 characters. Only alphanumeric non-special characters allowed. Must match the UUID of an existing instance. - outputSuppressionMode: One of allow, suppress. Only these modes are currently supported. 'allow' provides normal channel operation, 'suppress' will cause the output to be redirected to a 'not-found' endpoint. Can only be executed when a channel in an activated state

Delete a channel of an account

Dump the parameters of all events available for a service

- channelId: ID of the channel. String of maximum length 32 characters - instanceId: ID of the channel instance. String of maximum length 32 characters

Create stream conditioning event

- channelId: ID of the channel. String of maximum length 32 characters - instanceId: ID of the channel instance. String of maximum length 32 characters

Dump the parameters of one Event

- channelId: ID of the channel. String of maximum length 32 characters - instanceId: ID of the channel instance. String of maximum length 32 characters - eventId: ID of the event. String of maximum length 32 characters

Create Live2VOD recording

- channelId: ID of the channel. String of maximum length 32 characters - instanceId: ID of the channel instance. String of maximum length 32 characters

Switch the active source of a started channel of an account

Switches the active source of a started channel instance.

Mark a channel for confidence monitoring

DEPRECATED - API no longer does anything.

Retrieve output playlist file details for a channel of an account

Retrieves the list of outputs for a specified channel. Each output has the following form: - type: Type of this channel output, one of: hls, dash - url: Output URL of this corresponding output type

Start a stopped channel of an account

Deprecated - use POST instead

Stop a started channel of an account

Deprecated - use POST instead

Retrieves thumbnail for given channel

Deprecated - will not return any data

List available cloud providers for an account

Get cloud provider information for an account

List credentials associated with an account

Lists all of the credentials for this account.

Create a new credential with a new ID

Creates a single set of credentials. Takes a document of the form: - - type: required - specify which type of secret to use: `cpix, grf, sas, spn, gac, asc, s3, logging` - name: required - name of the secret - secret: required - the actual secret in JSON format; the formats for secrets are described below and the format must match the specified `type` - expiryDate: required - the expiry date of the credential in YYYY-MM-DD UTC format (day inclusive) Secret formats ============== <details><summary>Expand for information on secret formats</summary> cpix: ----- Client certificate used to authenticate against a CPIX-enabled key management server. - crt: required - base64 encoding of a TLS/SSL certificate in PEM format (utf-8). - key: required - base64 encoding of a private key in PEM format (utf-8). - keyPassword: optional - password for the private key, if required - url: required - URL prefix to which the client certificate applies - Note that is is a **prefix** so the example below will apply correctly if the keyServerUrl is https://www.examplekeyserver.com:2016/client/request_key_cpix?owner_uid=tenant1 For example: - { "crt": "SSB3b3VsZG4ndCBoYXZlIGJvdGhlcmVkIHRvIGRlY29kZSB0aGlz", "key": "U2VyaW91c2x5LCBpdCdzIG5vdCB3b3J0aCB0aGUgZWZmb3J0IC4uLiBub3RoaW5nIGV4Y2l0aW5nIGhlcmU=", "keyPassword": "youllneverguessthis", "url": "https://www.examplekeyserver.com" } grf: ---- - username: required - password: required - remote_url: required - webhook_url: optional For example: - { "username": "auser", "password": "youllneverguessthis", "remote_url": "http://remote1/push", "webhook_url": "http://my-moogsoft-alert-formatter:1234" } sas: ---- - sasToken: required - type: required - url: required For example: - { "sasToken": "sp=r&st=2021-09-01T14:50:33Z&se=2021-09-01T22:50:33Z&spr=https&sv=2020", "type": "azureSasToken", "url": "https://storeblobs.blob.core.windows.net/myblobs/blob1" } spn: ---- Service principal credentials used to create and manage deployments in Azure. - user: required - password: required - tenant: required - The Azure Active Directory tenant - subscription: required - The Azure subscription id - partner_id: optional - The customer usage attribution tracking id used in [Terraform](https://docs.microsoft.com/en-us/azure/marketplace/azure-partner-customer-usage-attribution#use-terraform) For example: - { "user": "auser", "password": "youllneverguessthis", "tenant": "d729ae64-67c9-411a-8787-3676603eb2c3", "subscription": "57629b83-317e-403c-ae59-9bdd0a4fd5b7", "partner_id": "9bc681ee-087b-4be9-899e-a4f12f617bfe" } gac: ---- Google Application Credentials used to create and manage deployments in Google Cloud. - type - required - project_id - required - private_key_id - required - private_key - required - client_email - required - client_id - required - auth_uri - required - token_uri - required - auth_provider_x509_cert_url - required - client_x509_cert_url - required For example: - { "type": "service_account", "project_id": "mygcpproject", "private_key_id": "4a3aeda866dc4f21b6824c882d886009", "private_key": "-----BEGIN PRIVATE KEY-----\nVGhpcyBpcyBwcml2YXRlIGtleSBpbmZvLgo=\n-----END PRIVATE KEY-----\n", "client_email": "sa@mygcpproject.iam.gserviceaccount.com", "client_id": "123456789012345678901", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/sa%40mygcpproject.iam.gserviceaccount.com" } asc: ---- AWS account credentials are stored in two ini files, the AWS Shared Credentials file and the AWS config file. For more information on the AWS files, see [this documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). The shared credentials file stores sensitive information, e.g.: - [default] aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY The config file, provides additional, less-sensitive context, e.g.: - [default] source_profile = default output=json role_arn = arn:aws:iam::170037402480:role/MyRole The ASC credential type stores both ini files in base64 encoded fields under 'files'. For example: - { "files": { "aws-credentials": "W2RlZmF1bHRdCmF3c19hY2Nlc3Nfa2V5X2lkID0gWU9VUl9BV1NfQUNDRVNTX0tFWV9JRAphd3Nfc2VjcmV0X2FjY2Vzc19rZXkgPSBZT1VSX0FXU19TRUNSRVRfQUNDRVNTX0tFWQo=", "aws-config": "W2RlZmF1bHRdCnJlZ2lvbj11cy13ZXN0LTIKb3V0cHV0PWpzb24K" } } s3: --- AWS credentials used to access S3 storage. The `accessKeyId` and `secretAccessKey` values can be generated from a service account in the AWS IAM management console or extracted from a shared credentials file. - url: required - URL to the AWS storage bucket - accessKeyId: required - AWS access key id - secretAccessKey: required - AWS secret access key For example: - { "url": "https://bucket-name.s3.eu-west-2.amazonaws.com/key-name", "accessKeyId": "YOUR_AWS_ACCESS_KEY_ID", "secretAccessKey": "YOUR_AWS_SECRET_ACCESS_KEY" } logging: -------- EdgeDelta ApiKey used to select the appropriate agent configuration (https://app.edgedelta.com/agent-settings.) Booleans defining whether or not Fluentbit / Edgedelta should be deployed. tagOverride: Should be the same as the tag in the config belonging to the API key by default. Can be set to a custom one and then used to filter on the ED dashboard. For example: - { "edgeDelta": { "deploy": true, "apiKey": "0e7e06a2-012a-4ee7-a536-a84a409e9665", "tagOverride": "PRODC" }, "fluentBit": { "deploy": false } } </details>

Get a specific set of credentials

Gets a specific set of credentials.

Updates a credential with ID equal to credentialId

Updates a specific set of credentials. Takes a document of the form: - - type: required - specify which type of secret to use: `cpix, grf, sas, spn, gac, asc, s3, logging` - name: required - name of the secret - secret: required - the actual secret in JSON format; the formats for secrets are described below and the format must match the specified `type` - expiryDate: required - the expiry date of the credential in YYYY-MM-DD UTC format (day inclusive) Secret formats ============== <details><summary>Expand for information on secret formats</summary> cpix: ----- Client certificate used to authenticate against a CPIX-enabled key management server. - crt: required - base64 encoding of a TLS/SSL certificate in PEM format (utf-8). - key: required - base64 encoding of a private key in PEM format (utf-8). - keyPassword: optional - password for the private key, if required - url: required - URL prefix to which the client certificate applies - Note that is is a **prefix** so the example below will apply correctly if the keyServerUrl is https://www.examplekeyserver.com:2016/client/request_key_cpix?owner_uid=tenant1 For example: - { "crt": "SSB3b3VsZG4ndCBoYXZlIGJvdGhlcmVkIHRvIGRlY29kZSB0aGlz", "key": "U2VyaW91c2x5LCBpdCdzIG5vdCB3b3J0aCB0aGUgZWZmb3J0IC4uLiBub3RoaW5nIGV4Y2l0aW5nIGhlcmU=", "keyPassword": "youllneverguessthis", "url": "https://www.examplekeyserver.com" } grf: ---- - username: required - password: required - remote_url: required - webhook_url: optional For example: - { "username": "auser", "password": "youllneverguessthis", "remote_url": "http://remote1/push", "webhook_url": "http://my-moogsoft-alert-formatter:1234" } sas: ---- - sasToken: required - type: required - url: required For example: - { "sasToken": "sp=r&st=2021-09-01T14:50:33Z&se=2021-09-01T22:50:33Z&spr=https&sv=2020", "type": "azureSasToken", "url": "https://storeblobs.blob.core.windows.net/myblobs/blob1" } spn: ---- Service principal credentials used to create and manage deployments in Azure. - user: required - password: required - tenant: required - The Azure Active Directory tenant - subscription: required - The Azure subscription id - partner_id: optional - The customer usage attribution tracking id used in [Terraform](https://docs.microsoft.com/en-us/azure/marketplace/azure-partner-customer-usage-attribution#use-terraform) For example: - { "user": "auser", "password": "youllneverguessthis", "tenant": "d729ae64-67c9-411a-8787-3676603eb2c3", "subscription": "57629b83-317e-403c-ae59-9bdd0a4fd5b7", "partner_id": "9bc681ee-087b-4be9-899e-a4f12f617bfe" } gac: ---- Google Application Credentials used to create and manage deployments in Google Cloud. - type - required - project_id - required - private_key_id - required - private_key - required - client_email - required - client_id - required - auth_uri - required - token_uri - required - auth_provider_x509_cert_url - required - client_x509_cert_url - required For example: - { "type": "service_account", "project_id": "mygcpproject", "private_key_id": "4a3aeda866dc4f21b6824c882d886009", "private_key": "-----BEGIN PRIVATE KEY-----\nVGhpcyBpcyBwcml2YXRlIGtleSBpbmZvLgo=\n-----END PRIVATE KEY-----\n", "client_email": "sa@mygcpproject.iam.gserviceaccount.com", "client_id": "123456789012345678901", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/sa%40mygcpproject.iam.gserviceaccount.com" } asc: ---- AWS account credentials are stored in two ini files, the AWS Shared Credentials file and the AWS config file. For more information on the AWS files, see [this documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). The shared credentials file stores sensitive information, e.g.: - [default] aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY The config file, provides additional, less-sensitive context, e.g.: - [default] source_profile = default output=json role_arn = arn:aws:iam::170037402480:role/MyRole The ASC credential type stores both ini files in base64 encoded fields under 'files'. For example: - { "files": { "aws-credentials": "W2RlZmF1bHRdCmF3c19hY2Nlc3Nfa2V5X2lkID0gWU9VUl9BV1NfQUNDRVNTX0tFWV9JRAphd3Nfc2VjcmV0X2FjY2Vzc19rZXkgPSBZT1VSX0FXU19TRUNSRVRfQUNDRVNTX0tFWQo=", "aws-config": "W2RlZmF1bHRdCnJlZ2lvbj11cy13ZXN0LTIKb3V0cHV0PWpzb24K" } } s3: --- AWS credentials used to access S3 storage. The `accessKeyId` and `secretAccessKey` values can be generated from a service account in the AWS IAM management console or extracted from a shared credentials file. - url: required - URL to the AWS storage bucket - accessKeyId: required - AWS access key id - secretAccessKey: required - AWS secret access key For example: - { "url": "https://bucket-name.s3.eu-west-2.amazonaws.com/key-name", "accessKeyId": "YOUR_AWS_ACCESS_KEY_ID", "secretAccessKey": "YOUR_AWS_SECRET_ACCESS_KEY" } logging: -------- EdgeDelta ApiKey used to select the appropriate agent configuration (https://app.edgedelta.com/agent-settings.) Booleans defining whether or not Fluentbit / Edgedelta should be deployed. tagOverride: Should be the same as the tag in the config belonging to the API key by default. Can be set to a custom one and then used to filter on the ED dashboard. For example: - { "edgeDelta": { "deploy": true, "apiKey": "0e7e06a2-012a-4ee7-a536-a84a409e9665", "tagOverride": "PRODC" }, "fluentBit": { "deploy": false } } </details>

Updates the expiry date of a credential with ID equal to credentialId

Updates the expiry date of a specific credential. Takes a document of the form: - - expiryDate: required - the expiry date of the credential in YYYY-MM-DD UTC format (day inclusive)

Delete a credential for an account

Deletes the specified set of credentials.

List deployments for an account

Create a new deployment for an account

List the available cluster types for this account.

Get a deployment for an account

Start, stop, or upgrade a deployment for an account

Delete a deployment for an account

List the clusters associated with a deployment

Get the details of a cluster associated with a deployment

Start, stop, scale or upgrade a cluster associated with a deployment

Request a cluster to reload its credentials. An optional hint may be provided about the credential types that have been changed

List DVRs associated with an account

Retrieves a list of all DVRs associated with this account. Each DVR has the form: - id: Optional. Must be unique amongst other dvrs for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - name: Must be unique amongst other dvrs for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. - template: ID of the template from the supported dvr templates. Must match an existing template ID. - instances: An array, where each entry is a dvr instance. These represent redundant replicas of the dvr, used to provide High Availability. For a non-HA dvr, a single `instance` entry will suffice. - id: Must be unique amongst this dvrs's instances. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID.

Create a new DVR for an account.

Creates a new DVR for this accountId - fields required are: - id: Optional. Must be unique amongst other dvrs for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - name: Must be unique amongst other dvrs for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. - template: ID of the template from the supported dvr templates. Must match an existing template ID. - instances: An array, where each entry is a dvr instance. These represent redundant replicas of the dvr, used to provide High Availability. For a non-HA dvr, a single `instance` entry will suffice. - id: Must be unique amongst this dvrs's instances. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID.

List a stored DVR of an account

Retrieve the configuration for the specified DVR. Each DVR has the form: - id: Optional. Must be unique amongst other dvrs for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - name: Must be unique amongst other dvrs for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. - template: ID of the template from the supported dvr templates. Must match an existing template ID. - instances: An array, where each entry is a dvr instance. These represent redundant replicas of the dvr, used to provide High Availability. For a non-HA dvr, a single `instance` entry will suffice. - id: Must be unique amongst this dvrs's instances. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID.

Delete a DVR of an account

Start a stopped DVR instance of an account

Stop a started DVR instance of an account

List entitlements and usage of an account

API to retrieve both the current account's usage and entitlements in one call. The key of each key:value pair is the name of the template and the value is the current total in the case of usage and the total allowed in the case of entitlements

List muxes associated with an account

Retrieves a list of all muxes (multiplexers) associated with this account. Each Mux has the form: - id: Unique auto-generated ID assigned to mux. Maximum length of 32 characters. Only alphanumeric non-special characters allowed - name: Must be unique amongst other muxes for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed - region: The region where this mux is deployed. - inputs: ID of the channels being used by this mux. Only available when the mux is started - config: Mux configuration (@TODO_MUX: schema for config - how do we share/sync this with stream processing?) See https://dev.azure.com/mediakind/MPD/_git/stream-processing?path=%2Fdocumentation%2Fhtml%2Fapi%2F spconfig.md.html&_a=preview Note: we override the id/name/inputs/sources objects and some of the output/statmux fields in the config - state: The current activation state of the mux. One of: stopped, start_requested, infra_creating, starting, started, stop_requested, stopping, start_error - timeStateLastChanged: The last time that this mux changed state

Create a new mux associated with an account

Creates a new mux for this accountId - fields required are: - id: Optional. Must be unique amongst other muxes for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified the API will autogenerate a 32 character UUID. - name: Must be unique amongst other muxes for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - region: The region where this mux will be deployed (must be one of the regions where an A/V pipe is deployed). - config: Mux configuration (@TODO_MUX: schema for config - how do we share/sync this with stream processing?) See https://dev.azure.com/mediakind/MPD/_git/stream-processing?path=%2Fdocumentation%2Fhtml%2Fapi%2F spconfig.md.html&_a=preview Note: we override the id/name/inputs/sources objects and some of the output/statmux fields in the config The X-Start-Now header will cause the mux to be started immediately on successful creation

List details of mux associated with an account

Retrieve the configuration for the specified mux. Each mux has the form: - id: Unique auto-generated ID assigned to mux. Maximum length of 32 characters. Only alphanumeric non-special characters allowed - name: Must be unique amongst other muxes for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed - region: The region where this mux is deployed. - inputs: ID of the channels being used by this mux. Only available when the mux is started - config: Mux configuration (@TODO_MUX: schema for config - how do we share/sync this with stream processing?) See https://dev.azure.com/mediakind/MPD/_git/stream-processing?path=%2Fdocumentation%2Fhtml%2Fapi%2F spconfig.md.html&_a=preview Note: we override the id/name/inputs/sources objects and some of the output/statmux fields in the config - state: The current activation state of the mux. One of: stopped, start_requested, infra_creating, starting, started, stop_requested, stopping, start_error - timeStateLastChanged: The last time that this mux changed state

Update parameters of mux associated with an account

Updates the mux for this account specified by the muxId. Takes a document of the form: - id: Optional. Must be unique amongst other muxes for this account. Maximum length of 32 characters. Only alphanumeric non-special characters allowed. Must match the ID being updated - name: Must be unique amongst other muxes for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - config: Mux configuration (@TODO_MUX: schema for config - how do we share/sync this with stream processing?) See https://dev.azure.com/mediakind/MPD/_git/stream-processing?path=%2Fdocumentation%2Fhtml%2Fapi%2F spconfig.md.html&_a=preview Note: we override the id/name/inputs/sources objects and some of the output/statmux fields in the config Can only be executed when a mux is not in an activated state

Delete mux associated with an account

Retrieve output details for mux associated with an account

Retrieves the list of outputs for a specified mux. Each output has the following form: - type: Type of this mux output (currently only srt) - url: Output URL of this corresponding output type

Start mux associated with an account

Stop mux associated with an account

List notifications associated with an account

- actioningUser: User that made the action occur. Can be the 'system' for unsolicited actions - eventTime: Date time of the action - message: Describes the notification - detail: Further info or API based details

List od deployments for an account

Create a new od deployment for an account

Get a deployment for an account

Scale up / down od deployment for an account

Delete an od deployment for an account

Get controller creds of an od deployment for an account

Provide od templates of an account

Retrieve a list of the OD Templates for this account

Create a new od template for an account

Delete an od template from an account

List roles and permissions of caller

Retrieves the Aquila-Streaming aaS related roles and permissions for the current user. - roles: contains an array of roles that the server uses to authorise operations. This is for information only and cannot be changed via this API. - permissions: is a block of key:value pairs listing the specific permissions for the declared roles. Each of these relates to specific API endpoints or actions that are permitted

List an account's deployed regions

Retrieves the regions valid for this account. Each entry has the format - id: unique id for this region - name: readable name for this region - cloud: cloud region is in

List sources of an account

Retrieves a list of all sources associated with this account, optionally filtered by a specified region. Each Source has the form: - id: Must be unique amongst other sources for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - name: Name of the source. Max of 32 characters. Only alphanumeric non-special characters allowed - region: Region of the source - inputMode: Input mode of the source. One of: rtp, rtp_fec, srtCaller, srtListener - programType: Single program or multiple programs transport stream. One of: spts, mpts - whitelistGroups: A list of the whitelist group ids associated with this source - ipAddresses: A list of the IP address information for this source. The IP address information in each source has the form: - id: Must be unique amongst all sources for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - type: Type of the source. One of: external, interconnect - ipAddress: The IP address of the source - port: The port of the source.

Create a source on a account

Creates a new source for this accountId - fields required are: - id: Optional. Must be unique amongst other sources for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified, the API will automatically generate a 32 character UUID. - name: Name of the source. Max of 32 characters. Only alphanumeric non-special characters allowed - region: Region of the source - inputMode: Input mode of the source. One of: rtp, rtp_fec, srtCaller, srtListener - programType: Single program or multiple programs transport stream. One of: spts, mpts - whitelistGroups: A list of the whitelist group ids associated with this source - ipAddresses: A list of the IP address information for this source and the ipAddress fields required are: - id: Optional. Must be unique amongst all sources for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not supplied, then the API will automatically generate a 32 character UUID which will be returned in the response. - type: Type of the source. One of: external, interconnect

Get a source of an account

Retrieve the configuration for the specified source. Each source has the form: - id: Must be unique amongst other sources for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - name: Name of the source. Max of 32 characters. Only alphanumeric non-special characters allowed - region: Region of the source - inputMode: Input mode of the source. One of: rtp, rtp_fec, srtCaller, srtListener - programType: Single program or multiple programs transport stream. One of: spts, mpts - whitelistGroups: A list of the whitelist group ids associated with this source - ipAddresses: A list of the IP address information for this source. The IP address information in the source has the form: - id: Must be unique amongst all sources for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - type: Type of the source. One of: external, interconnect - ipAddress: The IP address of the source - port: The port of the source

Update source name or whitelistGroups of a source of an account

Delete a source of an account

List statmux pools of an account

Retrieves a list of all statmux pools associated with this account. Each statmux pool has the form: - id: Must be unique amongst other statmux pools for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - name: Name of the statmux pool. Max of 32 characters. Only alphanumeric non-special characters allowed - bitrate: Maximum bitrate that can be used by statmux pool (bps) - videoOnly: Boolean indicating if statmux pool bitrate only covers video components.

Create a statmux pool on an account

Creates a new statmux pool for this accountId - fields required are: - id: Optional. Must be unique amongst other statmux pools for this account. Max of 32 characters. Only alphanumeric non-special characters allowed. If not specified, the API will automatically generate a 32 character UUID. - name: Name of the statmux pool. Max of 32 characters. Only alphanumeric non-special characters allowed - bitrate: Maximum bitrate that can be used by statmux pool (bps) - videoOnly: Boolean indicating if statmux pool bitrate only covers video components

Get a statmux pool of an account

Retrieve the configuration for the specified statmux pool. Each statmux pool has the form: - id: Must be unique amongst other statmux pools for this account. Max of 32 characters. Only alphanumeric non-special characters allowed - name: Name of the statmux pool. Max of 32 characters. Only alphanumeric non-special characters allowed - bitrate: Maximum bitrate that can be used by statmux pool (bps) - videoOnly: Boolean indicating if statmux pool bitrate only covers video components.

Update statmux pool parameters of an account

Delete a statmux pool of an account

Provide configuration templates of an account

Retrieve a list of the Channel Templates for this account.

Create a template on a account

Create a template on this account.

Delete a template from an account

List whitelist books of an account

Retrieves a list of all whitelsit groups associated with this account. Each book has the form: - id: Must be unique amongst other source IP for this account. Max of 30 characters. Only alphanumeric non-special characters allowed - name: The name of the whitelist book - entries: A list of IP address information for the book - description: A description of the whitelist book. The IP address information in each source has the form: - id: Must be unique amongst other whitelist IP entries for this account. Max of 30 characters. Only alphanumeric non-special characters allowed - name: The name of the whitelist IP entry - ipAddress: The IP address of the whitelist entry - comment: A comment about the whitelist entry.

Create whitelist book for an account

Get a whitelist books of an account

Update a whitelist book of an account

Delete a whitelist book of an account