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 configdata API uses the POST method to obtain the configuration data of monitor 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/configdata

    Request parameters

    ElementDescription
    authToken

    Value of authToken

    tenantId

    Tenant name

    Example: BmcRealm

    Options (Use one per request)
    monUniqNameUse the monitortypes operation to get the monUniqName.
    instKeyListincludes serverIdmonTypeId, and monInstId.
    Use the instances operation to get the serverId, monTypeId, and monInstId.

    Sample request with REST client

    After accessing the REST client, perform the following steps:

    1. 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
    2. Add a new header row and select Authorization as the header type.
    3. Enter the text authToken followed by the authToken generated through the login API. 
    4. Enter the input parameters in JSON format:
      1. tenantId — the tenant name, for example "BmcRealm".
      2. Select one of the following options:
    5. 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:

    Related topics

    Developing

    2 Comments

    1. How can we get the list of attributes that a given monitor instance has ?


      I can't see a way to do this via the API, and I have to refer to the documentation on the BMC site to get this which seems a bit backward when everything else is available in the API.

      1. Trevor Morgan, Thanks for your comments. I am forwarding your request to the product development teams.