Making API requests

The 

Some content is unavailable due to permissions.

REST API is a RESTful web service that operates on standard HTTP messages as defined in Hypertext Transfer Protocol RFC 2616. You invoke an API by sending an HTTP request message from your client application to the 

Some content is unavailable due to permissions.

API server. The API server returns an HTTP response message that contains the result of your request. The following figure illustrates this message exchange.

Note

While REST API messages are sent and received using HTTP, BMC recommends that you implement REST using HTTPS for increased security (and that you not use HTTP). This security is important if the client passes sensitive information, such as authentication credentials and security certificates, over the network. 

 

MakingAPIRequestsTSO.png

Communication with the 

Some content is unavailable due to permissions.

REST API is accomplished by using the HTTP protocol to send HTTP request messages and receive HTTP response messages. You can interact with the 

Some content is unavailable due to permissions.

REST API by using any of these methods:

Accessing the API from scripts and application programs entails sending and receiving HTTP messages by using the interface defined by a language-specific HTTP client library. Third-party REST clients enable you to enter HTTP requests from a graphical user interface or a command line.

The appropriate method depends on the complexity of your task. For a quick look into

Some content is unavailable due to permissions.

, such as getting a list of modules, you might use a REST client. For more complicated tasks, or tasks that you perform regularly, you might want to write a script or an application program.

Languages that you can use

Because Web services are language independent, you can develop your software using any programming or scripting language that supports sending and receiving standard HTTP messages, including:

  • Java
  • C#
  • Perl
  • PHP
  • PowerShell
  • Python
  • Ruby

 

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