Retrieving the list of monitor types
The monitortypes API uses the GET method to obtain the list of monitor types.
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/monitortypes
Request parameters
| Element | Description |
|---|---|
| tenantId | Tenant name Example: * |
| monitorCategory |
|
| authToken |
Sample request with REST client
After you access the REST client, perform the following steps:
- Enter the URL for the list of monitor types API. The generic format is:
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/monitortypes - Add the request parameters:
- tenantId
- monitorCategory
- 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.
- Click Send.
Sample JSON response
The following sample JSON response contains the list of monitor types for the monitortypes API:
Related topics
Was this page helpful? Yes No
Submitting...
Thank you
Comments
Log in or register to comment.