Multitenancy and the Infrastructure Management REST API

This section explains how multitenancy works for Infrastructure Management.

Overview of multitenancy for REST API

Infrastructure Management support the multitenancy feature only if your Infrastructure Management setup is integrated with BMC Atrium CMDB which is integrated with the BMC Cloud Lifecycle Management extension.

Now, the following REST APIs support multitenancy:

  • Stats
  • Configdata
  • Metadata

For more information about these APIs, see Retrieving data from Infrastructure Management.

You can use the multitenancy feature by specifying the tenant name in a REST API request, and it can fetch data that belongs to the tenant specified. It is optional to specify tenant name in a REST API request.

Sending a tenant name in a REST API request

If you use URL-encoded format, you can specify a tenant name in an authenticate REST API request. If you specify the tenant name in the authenticate REST API request, you do not have to specify it in your subsequent REST API requests. BMC TrueSight Infrastructure Management Server internally saves the tenant name and uses it for your subsequent REST API requests. If you do not specify the tenant name in an authenticate REST API request, you need to specify the tenant name in the configdata, metadata, or stats REST API requests. Based on the tenant name, your REST API request fetches data that is specific to that particular tenant.

If you use Base64 encoded format, you need to specify the tenant name in the configdata, metadata, or stats REST API requests.

The URL given in the following example fetches performance data for the specified devices that are specific to the tenant, calbro.

Example

http://bppmwsserver:80/api/Device/192.168.123.46/stats?starttime=2011-05-19T10:00:00&endtime=2011-05-19T12:00:00&idType=IPAddress&statstype=raw&attributetype=kpi&tenantName=calbro 

Note

After running REST API requests for a specific tenant, if you decide not to retrieve tenant-specific data, you must run the logout API.


For more information about the authenticate REST API request, see Authenticating user credentials.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*