Retrieving the list of monitor instances

The instances API uses the GET method to obtain a list of monitored instances.

TSWS APIs that use the POST method

API Endpoints	Description
token	Obtains the authToken required to perform all other operations
configdata	Retrieves configuration data of monitor instances
perfdata	Retrieves performance data of monitor instances

TSWS APIs that use the GET method

API Endpoints	Description
devices	Retrieves a list of monitored devices
instances	Retrieves a list of monitored instances
monitortypes	Retrieves a list of monitor types
tenants	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/instances

Request parameters

Element	Description
tenantId	The tenant name, for example "*"
deviceId	The API lists instances that are part of the provided tenant and device
monUniqName	The API lists instances that are part of the provided tenant and matches the provided monitor unique name.
serverId,monTypeId,monInstld	The API lists instances that are children of the monitor instance based on the serverId, monTypeId, and monInstld provided in the request.
authToken	The authorization token generated through the login API.

Sample request with REST client

After you access the REST client, perform the following steps:

Enter the URL for the list of monitor instances API. The generic format is:
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/instances
Add the query parameters:
1. tenantId — the tenant name, for example "*".
2. Select any one of the following options:
  - deviceId
    The API lists instances that are part of the provided tenant and device.
    URL with parameters - https://<PresentationServerHostName>/tsws/10.0/api/omprovider/instances?tenatId=<tenatId>&deviceId=<deviceId>
  - monUniqName
    The API lists instances that are part of the provided tenant and matches the provided monitor unique name.
    URL with parameters - https://<PresentationServerHostName>/tsws/10.0/api/omprovider/instances?tenatId=<tenatId>&monUniqName=<monUniqName>
  - deviceId and monUniqName
    The API lists instances that are part of the provided tenant and device and matches the provided monitor unique name.
    URL with parameters - https://<PresentationServerHostName>/tsws/10.0/api/omprovider/instances?tenatId=<tenatId>&deviceId=<deviceId>&monUniqName=<monUniqName>
  - serverId,monTypeId,and monInstld
    The API lists instances that are children of the monitor instance provided in the request.
    URL with parameters - https://<PresentationServerHostName>/tsws/10.0/api/omprovider/instances?tenatId=<tenatId>&serverId=<serverId>&monTypeId=<monTypeId>&monInstId=<monInstId>
Add a new header row and select Authorization as the header type.
Enter the text authToken followed by the authToken generated through the login API. See TSWS-authentication.
Click Send.

JSON response content

The response information follows the standard HTTP response status codes.

Sample JSON response

The following sample JSON response contains the monitor instances for the instances API: