Retrieving the list of monitor instances

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

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

Sample request with REST client

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

1. Enter the URL for the list of monitor instances API. The generic format is:
   https://<PresentationServerHostName>/tsws/10.0/api/omprovider/instances
2. Add the query parameters:
   1. tenantId — the tenant name, for example "*".
   2. Select any of the following options:
      
      • 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.
      • deviceId and monUniqName
        The API lists instances that are part of the provided tenant and device and matches the provided monitor unique name.
3. Add a new header row and select Authorization as the header type.
4. Enter the text authToken followed by the authToken generated through the login API. See TSWS authentication.
5. 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:

Related topics

Developing