RESTful API for BMC AMI Ops Console Management


The BMC AMI Ops Console Management RESTful API provides a set of endpoints that allow an API program to query and update configuration information from the BMC AMI Ops Console Management configuration database:

Related topics

Using

  • The API accesses services via HTTP version 1.1. For more information about HTTP 1.1, seeW3C internet standards document RFC 2615.

  • The BMC AMI Ops Console Management web server provides TLS encryption for all connections.
  • Because most API calls require authentication, a session-creation call (LOGON) returns an authentication token for use in the HTTP header of subsequent requests. 

Important

The RESTful API does not assume any particular client user agent or programming language. For information about how to use HTTP services in your preferred programming language, see the resources for your development environment.

Types of roles

There are two types of roles available for you in BMC AMI Ops Console Management: Product Administration role and User Administrator role. You can select these roles while creating a user account.

The features available in the Configuration component varies as per the user role you have chosen. For more information, see Creating-or-editing-a-user-account.

If you have selected both these roles, the Configuration component is available and displayed in the product. If you have not selected either of these roles, the Configuration component becomes unavailable. 

BMC AMI Ops Console Management offers the following RESTful API services:

 

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