Page tree

Skip to end of metadata
Go to start of metadata

The TrueSight Web Service (TSWS) login API uses the POST method to return an authToken value in the JSON response. The authToken provides the credentials and permissions of the user performing the operations and must be specified to authenticate all subsequent TSWS API requests. 

The authToken also contains an expiration date for using it.

TSWS APIs that use the POST method
loginObtains the authToken required to perform all other operations
configdataRetrieves configuration data of monitor instances
perfdataRetrieves performance data of monitor instances

TSWS APIs that use the GET method
devicesRetrieves a list of monitored devices
instances Retrieves a list of monitored instances 
monitortypesRetrieves a list of monitor types 
tenantsRetrieves a list of tenants 

Request syntax


Request parameters

usernameUser name performing the operation
passwordPassword to authenticate the user

Tenant name as it appears in the Presentation Server

Example: BmcRealm


The request parameters in JSON format:

"username": "<user name>",
"password": "<password>",
"tenantName": "<tenant name>"

Sample request with REST client

JSON response content

The JSON response includes an authToken if the authentication is successful. You must use this authToken value for subsequent requests.

Value that you specify in subsequent TrueSight Web Services operations.
Value returned by the API. This can be either true or false.
True indicates a successful operation and false indicates a failed operation.

Same as the responseTimeStamp.

To perform a TrueSight Web Services operation after this date, you must perform this operation again

Status returned by the API. For example, if the status code is 200, the status returned is OK.

Sample JSON response

"responseTimeStamp":   "2015-07-21T06:23:51",
"statusCode": "200",
"statusMsg": "OK",
            "authToken": "AQIC5wM2LY4Sfczv3QuPxC851ZfQ-.*",
            "authPassed": true,
            "expires": "2015-07-21T06:23:51",
            "status": "OK"

Related topics


1 Comment

  1. On TSIM you can also get the metadata. Would be great if this would also be possible on TSPS