Alert Notification

Live

Alert Notification

+ Day(s) remaining in the trial

Overview

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. Users can be organized into groups and you can send notifications to several users at once. Notifications can be sent by email, SMS, voice, and mobile message. The Alert API can receive alert requests from any event source to the IBM Alert Notification service to support hybrid cloud deployments. The API can also be used to create the policies that are used to match the alerts and direct notifications to the appropriate recipients. The Users and Groups that will receive notifications for the alerts can also be managed with the API. Lastly, messages can be created with the API to manually send notifications to a specified set of recipients.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Global Parameters

This section contains global variables, which apply to all of the endpoint definitions of this API. You can use this section to set these variables once, and have the values pre-filled for every endpoint in the Documentation section. The values set can be used with the built-in testing. You can always override the value in the endpoint definition of the Documentation section.
Global variables


Documentation

Alert Notification:

/alerts

createAlert
Creates alert

POST   /alerts/v1

			https://{hostname}/api/alerts/v1
		
Keys
Global variables

hostname

STRING , required

hostname

STRING , required

Request code
								
HttpResponse<String> response = Unirest.post("https://{hostname}/api/alerts/v1") .header("authorization", "Basic REPLACE_BASIC_AUTH") .body("{\"ApplicationsOrServices\":[null],\"Details\":[{\"Name\":\"string\",\"Value\":\"string\"}],\"EmailMessageToSend\":{\"description\":\"Email message, optionally formatted using Mustache templates\",\"additionalProperties\":false,\"properties\":{\"Body\":{\"type\":\"string\"},\"Subject\":{\"type\":\"string\"}},\"required\":[\"Body\",\"Subject\"]},\"Identifier\":\"string\",\"SMSMessageToSend\":\"string\",\"Severity\":{\"description\":\"Strength\",\"enum\":[\"Fatal\",\"Critical\",\"Major\",\"Minor\",\"Warning\",\"Indeterminate\",\"Clear\",6,5,4,3,2,1,0],\"type\":[\"string\",\"integer\"]},\"Source\":\"string\",\"Type\":{\"description\":\"Resolution indicates the alert is no longer outstanding, defaults to Problem\",\"enum\":[\"Problem\",\"Acknowledged\",\"Resolution\"],\"type\":[\"string\"]},\"URLs\":[{\"Description\":\"string\",\"URL\":\"string\"}],\"VoiceMessageToSend\":\"string\",\"What\":\"string\",\"When\":{\"description\":\"Date and time specified in ISO-8601 format or UTC\",\"type\":[\"string\",\"integer\"]},\"Where\":\"string\"}") .asString();
Request model

Identifier

STRING , optional

Identifier used for deduplication

What

STRING , required

Summary

Where

STRING , required

Location

Source

STRING , optional

Source

ApplicationsOrServices

ARRAY , optional

Applications or Service Impacted

URLs

ARRAY , optional

Description

STRING , required

URL

STRING , required

Details

ARRAY , optional

Name

STRING , required

Value

STRING , required

EmailMessageToSend

OBJECT , optional

Subject

STRING , required

Body

STRING , required

SMSMessageToSend

STRING , optional

SMS message, optionally formatted using Mustache templates

VoiceMessageToSend

STRING , optional

Voice message, optionally formatted using Mustache templates

Request example
{
  "Identifier": string,
  "What": string,
  "Where": string,
  "Source": string,
  "ApplicationsOrServices": [],
  "URLs": [{
    "Description": string,
    "URL": string
  }],
  "Details": [{
    "Name": string,
    "Value": string
  }],
  "EmailMessageToSend": {
    "Subject": string,
    "Body": string
  },
  "SMSMessageToSend": string,
  "VoiceMessageToSend": string
}
Response model

200

Successful request

Body

Identifier

STRING , optional

Identifier used for deduplication

ShortId

STRING , required

Unique user-facing identifier

What

STRING , required

Summary

Where

STRING , required

Location

Source

STRING , optional

Source

ApplicationsOrServices

ARRAY , optional

Applications or Service Impacted

URLs [URLs]

ARRAY , optional

Details [Details]

ARRAY , optional

EmailMessageToSend [EmailMessage]

OBJECT , optional

SMSMessageToSend

STRING , optional

SMS message

VoiceMessageToSend

STRING , optional

Voice message

DocType

STRING , required

NotificationState

STRING , required

State of alert through reporting process

FirstOccurrence

INTEGER , required

First alert occurrence (When) in UTC format

LastNotified

INTEGER , optional

Last notification that was sent in unix timestamp

InternalTime

INTEGER , required

Internal server system time the alert was posted

Expired

BOOLEAN , optional

Alert is no longer valid and will be disabled from UI

Description

STRING , required

URL

STRING , required

Name

STRING , required

Value

STRING , required

Subject

STRING , required

Body

STRING , required

208

Already reported

Body

400

Invalid request

Body

415

Invalid media type

Body

Response example

200

Successful request

								{
  "Identifier" : string,
  "ShortId" : string,
  "What" : string,
  "Where" : string,
  "Source" : string,
  "ApplicationsOrServices" : [string],
  "URLs" : [{
    "Description" : string,
    "URL" : string
  }],
  "Details" : [{
    "Name" : string,
    "Value" : string
  }],
  "EmailMessageToSend" : {
    "Subject" : string,
    "Body" : string
  },
  "SMSMessageToSend" : string,
  "VoiceMessageToSend" : string,
  "DocType" : [Alert],
  "NotificationState" : [Unnotified, Notified, Acknowledged, Archived, Escalated],
  "FirstOccurrence" : integer,
  "LastNotified" : integer,
  "InternalTime" : integer,
  "Expired" : boolean
}
							

208

Already reported

								
							

400

Invalid request

								
							

415

Invalid media type

								
							
deleteAlertByShortId
Deletes an alert

DELETE   /alerts/v1/{id}

			https://{hostname}/api/alerts/v1/{id}
		
Keys
Global variables

hostname

STRING , required

hostname

STRING , required

Path and Query parameters

id

URL , required

Short Alert ID

Request code
								
HttpResponse<String> response = Unirest.delete("https://{hostname}/api/alerts/v1/{id}") .header("authorization", "Basic REPLACE_BASIC_AUTH") .asString();
Response model

204

Successful request

404

Unable to locate alert

500

Error archiving alert

Response example

204

Successful request

404

Unable to locate alert

500

Error archiving alert

getAlertByShortId
Gets an alert

GET   /alerts/v1/{id}

			https://{hostname}/api/alerts/v1/{id}
		
Keys
Global variables

hostname

STRING , required

hostname

STRING , required

Path and Query parameters

id

URL , required

Short Alert ID

Request code
								
HttpResponse<String> response = Unirest.get("https://{hostname}/api/alerts/v1/{id}") .header("authorization", "Basic REPLACE_BASIC_AUTH") .asString();
Response model

200

Successful request

Body

Identifier

STRING , optional

Identifier used for deduplication

ShortId

STRING , required

Unique user-facing identifier

What

STRING , required

Summary

Where

STRING , required

Location

Source

STRING , optional

Source

ApplicationsOrServices

ARRAY , optional

Applications or Service Impacted

URLs [URLs]

ARRAY , optional

Details [Details]

ARRAY , optional

EmailMessageToSend [EmailMessage]

OBJECT , optional

SMSMessageToSend

STRING , optional

SMS message

VoiceMessageToSend

STRING , optional

Voice message

DocType

STRING , required

NotificationState

STRING , required

State of alert through reporting process

FirstOccurrence

INTEGER , required

First alert occurrence (When) in UTC format

LastNotified

INTEGER , optional

Last notification that was sent in unix timestamp

InternalTime

INTEGER , required

Internal server system time the alert was posted

Expired

BOOLEAN , optional

Alert is no longer valid and will be disabled from UI

Description

STRING , required

URL

STRING , required

Name

STRING , required

Value

STRING , required

Subject

STRING , required

Body

STRING , required

404

Unable to locate alert

Response example

200

Successful request

								{
  "Identifier" : string,
  "ShortId" : string,
  "What" : string,
  "Where" : string,
  "Source" : string,
  "ApplicationsOrServices" : [string],
  "URLs" : [{
    "Description" : string,
    "URL" : string
  }],
  "Details" : [{
    "Name" : string,
    "Value" : string
  }],
  "EmailMessageToSend" : {
    "Subject" : string,
    "Body" : string
  },
  "SMSMessageToSend" : string,
  "VoiceMessageToSend" : string,
  "DocType" : [Alert],
  "NotificationState" : [Unnotified, Notified, Acknowledged, Archived, Escalated],
  "FirstOccurrence" : integer,
  "LastNotified" : integer,
  "InternalTime" : integer,
  "Expired" : boolean
}
							

404

Unable to locate alert

Loading content...