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 | |
| serverId | |
| monTypeId | |
| monInstld | |
| authToken |
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:
- tenantId — the tenant name, for example "*".
- 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.
- deviceId
- 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:
Related topics
Was this page helpful? Yes No
Submitting...
Thank you
Comments
I know this was already brought to BMC's attention, but for other's here who may not know:
When calling this route of the API, for now you must use DeviceId, MonUniqName, or the combination of the two. Using the ServerId, MonTypeId, and MonInstId does not work.
Even if you send a valid request, it will not return the content you are looking for. But you can find that same content using the first three methods.
BMC has said that they have marked this as a defect, as it does not match the documentation, or how other routes of the API function.
Hey Chase - Thank you for pointing this out.
Do you know of a way to fetch the deviceId of a given device name? I see the API call for retrieving the list of devices but this is pulling all the devices connected.
Hi Mark C,
Our SME had the following response:
There is no REST API to retrieve the deviceid for a given device name. For the devices API call that you are referring to at the following page, we have documented a note for your query as per our SME's response:
https://docs.bmc.com/docs/tsps113/retrieving-the-list-of-devices-765456180.html
Hence closing the comment as per our SME's response.
FYI Shuchi Bakshi
Regards,
Shreya
Hi Chase Colvin,
Thanks for your feedback. The serverId, monTypeId, and monInstId query parameter combination has now been removed from the documentation. However, it would be of great help if you could forward the defect ID and contact details of the person you connected with from the Customer Escalation team so that we can coordinate with our internal teams for the issue.
Regards,
Shreya
Log in or register to comment.