- Installation of the following TrueSight Operations Management components:
- TrueSight Presentation Server
- TrueSight Infrastructure Management
- Installation of a client utility, such as Postmam
The REST API is versioned separately from the TrueSight Presentation Server. The API version provided with this version of the TrueSight Presentation Server is version 10.0. As necessary, newer versions of the API will be released with future product releases.
JSON is used for both request and response bodies. Each API request must include the following content-type parameter in the request header:
All timestamps in response bodies are returned in ISO 8601 format:
The following table contains the endpoints in the TSWS REST API. For details about the endpoints, see the <interactive REST API documentation>.
Obtains the authToken required to perform all other operations
Retrieves configuration data of monitor instances
Retrieves performance data of monitor instances
Retrieves a list of monitored devices
Retrieves a list of monitored instances
Retrieves a list of monitor types
Retrieves a list of tenants
The response body contains the results of all requests. In addition to the requested content, the response body also contains status content that describes the success or failure of the request.
- Successful requests are indicated by returned 2xx HTTP status codes.
- Failed requests are indicated by returned
4xx (client error)or
5xx (server error)HTTP status codes.
The response body also contains an object that contains details of the error, with the following fields:
The HTTP request status code
A description of the request statusCode
|responseMsg||Status of the response|
Portion of the response that contains the specified content
For unsuccessful requests, this field can also provide some detail or
Here is an example request, resulting in the response 400 Bad Request: