Maintenance outage for upgrade on Sunday, September 22

This site, docs.bmc.com, will be inaccessible for two hours starting at 9 AM CDT, Sunday, September 22, for a platform upgrade.

    Page tree
    Skip to end of metadata
    Go to start of metadata

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

    TSWS APIs that use the POST method
    APIDescription
    loginObtains the authToken required to perform all other operations
    configdataRetrieves configuration data of monitor instances
    perfdataRetrieves performance data of monitor instances

    TSWS APIs that use the GET method
    APIDescription
    devicesRetrieves a list of monitored devices
    instances Retrieves a list of monitored instances 
    monitortypesRetrieves a list of monitor types 
    tenantsRetrieves 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

    ElementDescription
    tenantIdthe tenant name, for example "BmcRealm"
    deviceIdThe 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:

    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 "BmcRealm".
      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.
        • serverIdmonTypeId, and monInstId
          These three inputs together form the monitor instance key. The API lists child instances that are part of the provided tenant and matches the given parent instance details or key.
    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

    4 Comments

    1. Is it possible to use the device name instead of the id?

      1. Hi Patrick,

        You cannot use the device name. It has to be the device ID.

    2. This is a pity. Then you first have to figure out the deviceId before you can get the instances. Instead of one call you have to make two.

    3.