Overview of the Infrastructure Management REST API

Infrastructure Management provide operations for a REST API client to exchange events and data with Infrastructure Management. Features of Infrastructure Management include:

  • Retrieving data from Infrastructure Management
  • Managing CIs
  • Generating events for Infrastructure Management and its integrations
  • Managing SLO information
  • Retrieving details about Integration Services

Accessing Infrastructure Management REST API

You can access each Infrastructure Management REST API through a URL. The generic format of a Infrastructure Management REST API URL is as follows:

http|https://<serverHost>:<port>/bppmws/api/<resourceType>/<resourceID>/action?<queryParam1>&<queryParam2>&...<queryParamn>

Example

https://bppm:443/bppmws/api/slo/create?filtertype=device&filterid=device1&filteridtype=name

Entry

Description

http|https

Type of protocol to send the request. Infrastructure Management support both HTTP and HTTPS protocols.

serverHost

Host name of the BMC TrueSight Infrastructure Management Server

port

Port number through which communication is established. The default port number is 80 if you use the HTTP protocol and 443 if you use the HTTPS protocol.

resourceType

Type of resource that you want the REST API to interact with. Infrastructure Management support the following resource types:

  • Device
  • MonitorInstance
  • slo
  • CI

resourceID

Identifier of a specific resource that you want the REST API to interact with. Infrastructure Management support the following resource identifiers:

  • Name — Name of the resource
  • IPAddress — IP address of the resource
  • URI — Uniform Resource Identifier of the resource
  • RECON_ID — Unique identifier of a configuration item (CI)

Each REST API supports specific resource identifiers, and the supported identifiers vary for each REST API.

action

Type of action that you want to perform using the REST API

queryParam1, queryParam2, queryParamn

Additional parameters that you want to provide in the request

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

Comments