Testing API operations

Last modified: Wednesday July 02, 2025.

After obtaining an authentication cookie, you can test API operations from the Explorer or Postman

Testing operations from the API Explorer

1. In the Video or Protect web app, click your user initials and select API Explorer.
   1. Alternatively, go to https://alta-video.readme.io/reference/get_api-v1-about.
2. Select the required operation from the list.
3. Enter any required BODY PARAMS.
4. In CREDENTIALS, enter your authentication Cookie.
5. In URL, click the Base URL string and enter your deploymentName, region, and domain.
6. Click Try It!

Testing API operations from Postman

1. Click New and select HTTP.
2. In the address bar, select the request method for the operation as shown in the API Explorer.
3. In the address bar, enter the URL for the request: https://<deployment name>.<region>.alta.avigilon.com/api/v1/<operation>
4. Open the Headers tab and set the Content-Type to application/json.
5. Open the Body tab and select raw and set the type as JSON from the dropdown.
6. Enter the required JSON payload, for example: {"action":"activate"}
   1. You can use the API Explorer to help construct the payload. Enter the required BODY PARAMS and check the --data value in the CURL REQUEST.
7. Click SEND.