Retrieving the configuration data of monitor instances
The configdata API uses the POST method to obtain the configuration data of monitor instances.
APIs that use the POST method
API | Description |
---|---|
Obtains the authToken required to perform all other operations | |
Retrieves configuration data of monitor instances | |
Retrieves performance data of monitor instances |
APIs that use the GET method
API | 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-Web-service-authentication.
Request syntax
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/configdata
Request parameters
Element | Description |
---|---|
authToken | Value of authToken |
tenantId | Tenant name Example: BmcRealm |
Options (Use one per request) | |
monUniqName | Use the monitortypes operation to get the monUniqName. |
instKeyList | includes serverId, monTypeId, and monInstId. |
Sample request with REST client
After accessing the REST client, perform the following steps:
- 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 - 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.
- Enter the input parameters in JSON format:
- tenantId — the tenant name, for example "BmcRealm".
- Select one of the following options:
- monUniqName
Use the list of monitor types API to get the monUniqName. - instKeyList that includes serverId, monTypeId, and monInstId.
Use the list of monitor instances API to get the serverId, monTypeId, and monInstId.
- monUniqName
- Click Send.
Using monUniqName
Using instKeyList that includes serverId, monTypeId, and monInstId
Sample JSON response
The response information follows the standard HTTP response status codes.
Sample JSON response for the configuration data of monitor instances API: