Retrieving the configuration data of monitor instances


The configdata API uses the POST method to obtain the configuration data of monitor instances. 

TSWS APIs that use the POST method

API Endpoints

Description

Obtains the authToken required to perform all other operations

Retrieves configuration data of monitor instances

Retrieves performance data of monitor instances

TSWS APIs that use the GET method

API Endpoints

Description

Retrieves a list of monitored devices

Retrieves a list of monitored instances 

Retrieves a list of monitor types 

Retrieves a list of tenants 

Before you begin

You must have used the login API to obtain the authToken, which authenticates the user performing the operation. For details, see TSWS-authentication.

Request syntax

https://<PresentationServerHostName>/tsws/10.0/api/omprovider/configdata

Request parameters

Element

Description

authToken

Value of authToken

tenantId

Tenant name

Example: *

Options (Use one per request)

monUniqName

Use the monitortypes operation to get the monUniqName.

instKeyList

includes serverId, monTypeId, and monInstId.
Use the instances operation to get the serverId, monTypeId, and monInstId.

Sample request with REST client

After accessing the REST client, perform the following steps:

  1. Enter the URL for the configuration data of monitor instances API. The generic format is:
    https://<Presentation Server host name>/tsws/10.0/api/omprovider/configdata
  2. Add a new header row and select Authorization as the header type.
  3. Enter the text authToken followed by the authToken generated through the login API. 
  4. Enter the input parameters in JSON format:
    1. tenantId — the tenant name, for example "*".
    2. Select one of the following options:
  5. Click Send.

Using monUniqName

configDataAPI.png

Using instKeyList that includes serverId, monTypeId, and monInstId

configDataAPI2.png

Sample JSON response

The response information follows the standard HTTP response status codes.

Sample JSON response for the configuration data of monitor instances API:

configDataAPI_response.png

Related topics

Developing