The API Protocol - AWS Elemental Conductor Live 3

This is version 3.17 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

The API Protocol

The AWS Elemental Conductor Live 3 API can be accessed using HTTP or HTTPS. The API follows the REST architectural framework. In accordance with REST guidelines, the API exposes four types of operations based on the requesting HTTP(S) method:

  • POST

  • GET

  • PUT

  • DELETE

Entities, Attributes, Elements, Properties, Parameters

The entities that the AWS Elemental Conductor Live 3 API works with are:

  • Redundancy groups

  • Channels

  • Nodes

  • Profiles

  • Schedules

  • MPTS outputs

  • MPTS members (SPTS programs)

  • Routers

These entities have attributes in AWS Elemental Conductor Live 3 . In the API, these attributes are passed in the XML body of the request or response. They are passed as either:

  • XML elements (if they are read-write), or

  • Properties of an XML element (if they are read-only).

API requests may have parameters, which are presented in angle brackets. For example, <ID of redundancy group> is a parameter in this POST request:

/redundancy_groups/<ID of redundancy group>/members