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 EndpointsDescription
tokenObtains 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
API EndpointsDescription
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


Request parameters

tenantIdthe tenant name, for example "*"
deviceIdThe API lists instances that are part of the provided tenant and device

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:
  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


Was this page helpful? Yes No Submitting... Thank you


  1. Chase Colvin

    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.

    Jan 14, 2020 03:32
    1. Mark C

      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.

      Apr 15, 2020 08:47
      1. Shreya Gurukiran

        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:

        Hence closing the comment as per our SME's response.

        FYI Shuchi Bakshi



        Jul 16, 2020 01:11
    1. Shreya Gurukiran

      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.



      Jul 15, 2020 11:58