Selecting a Version of an API Call

As the device API evolves and new features are added, maintain backwards compatibility by setting the desired API version within the request. Set the API version with the version URI parameter, or in the URL path as shown below. If a request has only one version, this value is ignored.


To use version 1 of the API, make all API requests using the following:

URL path option: https://[device_ip]/api/v1/[request_path]
URI parameter option: https://[device_ip]/api/[request_path]?version=1

If no version is specified, the request is executed using the latest API version.