API Activity Control

Activities can be started or stopped by an external system via API. With an API integration, you can start and stop Activities and return a list of available behaviors.

Note

To control Activities via API, you must first create an API integration. See Integrations for more information.

Command Structure

The API command structure is as follows:

Invoke-WebRequest -Method POST -Headers @{ "x-haivision-api-token"="<TOKEN>" } https://<DOMAIN>/Haivision/Infrastructure/Manager/Activity/<ACTIVITY_ID>/<COMMAND>

Where:

• <TOKEN> is the token generated when completing the task outlined in Adding Integration Accounts.
• <DOMAIN> is the domain of your Command 360 system.
• <ACTIVITY_ID> is the ID of the Activity you are controlling. This value can be found on the Basic Information tab of the Activity Manager.
• <COMMAND> is one of two commands:
  • Start
  • Stop