DOdolby
Engines

Update an engine by ID

Changed on

Only name and priority can be updated while the engine is not stopped; updates to any other field are rejected with a 409 engine_playing error.

patch/engines/{id}

Request

  • Base URL
    https://api.theo.live/v2
  • Auth
    HTTP basic

Path parameters

idstring required

Engine ID

Request body

ingestIdstring

Ingest ID to connect the engine to

backupIngestIdstring nullable

ID of the backup ingest the engine falls back to when the primary ingest is unavailable. Must be another ingest of the same channel, in the engine region; both ingests must be of type srt-pull, srt-push, rtmp-pull or rtmp-push. Pass null to unset it.

namestring

Name of the engine

regionstring

Region ID

prioritynumber

Engine priority (-100 to 100), lower value is higher priority

drmboolean

Enable DRM. Only possible when enabled for your organization.

drmProvider'ezdrm' | 'drmtoday'

DRM provider to use. Only possible when your organization has access to the provider. Defaults to the organization default provider.

daiAssetKeystring nullable

DAI asset key

Response

Updated engine

Changes

  • 5f4413af6d13Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 304c905ec530Revision changes
    • warning

      added the new provisioning enum value to the / response property for the response status