API Endpoint Call Headers

API endpoint call headers have a standardized syntax that allow you to see the operation (GET, PUT, POST, or DELETE) the endpoint is performing, as well as the element that is being queried or modified by the endpoint. Each endpoint includes user identification information as well as information on the specific SIP element that is being added, modified, deleted, sent or retrieved. The endpoint calls are structured in the JSON key/value pair format.

Each endpoint is comprised of a call method and one or several resources. The call method, GET, for example, defines the action the call is performing. The resource is the element in SIP on which the action is performed. In the example below, the API is retrieving a list of all the data collectors in your network.

This example uses the DELETE call method to remove a specific data collector, which is identified by its ID.

This examples uses the POST call method to create a new assessment within an existing domain.

This more complex example uses the PUT call method to revise one of the available parameters in a specific control ID inside a specific domain ID.