Introduction

Alert Notification offers easy-to-implement filtering of alerts and policy-based notifications that let you define which alerts you want to be notified about. The Alert API can receive alert requests from any event source to the IBM Alert Notification service to support hybrid cloud deployments.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Methods

createAlert

Creates alert

POST /alerts/v1
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Alert payload

Response

Status Code

  • Successful request

  • Already reported

  • Invalid request

  • Invalid media type

No Sample Response

This method does not specify any sample responses.

deleteAlertByShortId

Deletes an alert

DELETE /alerts/v1/{id}
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Path Parameters

  • Short Alert ID

Response

Status Code

  • Successful request

  • Unable to locate alert

  • Error archiving alert

No Sample Response

This method does not specify any sample responses.

getAlertByShortId

Gets an alert

GET /alerts/v1/{id}
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Path Parameters

  • Short Alert ID

Response

Status Code

  • Successful request

  • Unable to locate alert

No Sample Response

This method does not specify any sample responses.