Managing policies, event data, and metric data with REST APIs
As an administrator, use REST APIs to perform the following tasks:
- Managing events with REST APIs
- Managing custom enumerations with REST APIs
- Managing event policies with REST APIs
- Performing metric operations with the REST API
- Configuring blackout policies with REST APIs
- Managing alarm policies with REST APIs
- Managing baseline metrics in alarm policies with REST APIs
- Managing data tables in dynamic enrichment policies with REST APIs
- Managing dynamic monitor type registration with REST APIs
- Managing global variables with REST APIs
- Managing the Agent Query Tool PSL commands with REST APIs
- Managing time frames for event policies with REST APIs
API Base URL
The API base URL consists of:
<Scheme>://<Your BMC Helix Portal URL>/<BasePath>/<EndpointPath>
The following example displays the URL components:
- Method: Required HTTPS method (also known as operation or verb) which tells the web service about the type of operation you are requesting. The supported endpoints use GET, POST, PUT, and DELETE methods.
- Scheme: Protocol used by the API to transmit a request. HTTPS is the supported protocol for all the endpoints.
- Your BMC Helix Portal URL: Product URL that you received in the activation email.
- Base path: URL prefix used by all the API paths. Starts with a leading slash (/). The base path helps the web service identify the correct resource for running the API. This path also includes the API version.
- Endpoint path: Path specific to the particular endpoint you want to run. Based on the type of endpoint, this path might include query parameters that can help identify the resource selection criteria.
Supported HTTP status codes
When responding to requests, the REST API uses some of the standard HTTP status codes. The following table provides a summary of the status codes that are returned.
|200||OK||The operation is successful.|
|400||Bad request||The request is invalid.|
|404||Not found||This status code is used when a resource does not exist.|
|401||Unauthorized access||The authentication failed for the user.|
|403||Forbidden||The user is not allowed to perform the operation.|
|500||Application server error||An error has occurred on the server.|