How to Make API Requests to Cloud-Connected Systems Over the Internet

-----------------------------------

Affected Roles: Administrator, Power Users

Related Digital Watchdog VMS Apps: DW Spectrum

Last Edit: April 4, 2025

-----------------------------------

Making an API Request

Check the documentation and find the API request that you need, then make and test the request using the local system IP address.

For Example:

There are two ways to do that:

Option 1: Open the DW Spectrum System in the DW Cloud Portal and check the URL for the System ID.

For Example: https://dwspectrum.digital-watchdog.com/systems/397f56fb-4c5c-485e-a923-9bea345fa7ba

Cloud System ID = 397f56fb-4c5c-485e-a923-9bea345fa7ba

Option 2: Make an API request using /api/moduleInformation. The Cloud System ID will be listed in reply.

For Example: http://127.0.0.1:7001/api/moduleInformation

**NOTE: For more information finding the DW Cloud System ID, you can refer to DW Spectrum - Locating the DW Cloud System ID.

In your original request, replace the local IP and port number with https://{systemID}.relay.vmsproxy.com.

For Example:

http://127.0.0.1:7001/api/createEvent?source=Cloud&caption=Test

Turns into à https://https://397f56fb-4c5c-485e-a923-9bea345fa7ba.relay.vmsproxy.com/

Which then becomes à https://397f56fb-4c5c-485e-a923-9bea345fa7ba.relay.vmsproxy.com/api/createEvent?source=Cloud&caption=Test

Known Issues and Limitations

This functionality is subject to change without advanced notice. Updates are often announced in release notes when changes occur.
This method only supports the HTTPS protocol.
This method does not support browser-based requests due to CORS protection.

______________________________________________________________________________

For More Information or Technical Support