/
Alerts REST API

IBM DataPower Operations Dashboard v1.0.17.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Alerts REST API

Owned by Meytal Ben-Tzvi (Deactivated)
Last updated: Mar 22, 2022
7 min read

Available alert actions via APIs

Get / Create / Update / Execute / Delete alerts

Authorization:

Authentication: Basic authentication

Roles: it is recommended to read Role Based Access Control page for understanding build-in and custom roles permissions.

From CLI (example):

curl -u username:password https://<dpod hostname>/op/api/v2/alerts/{{productView}}

GET Retrieve All Alerts

URL:

GET - https://{{dpodHostname}}/op/api/v2/alerts/{{productView}}

Request - None.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Product view APIC / IDG

String

  • APIC

  • IDG

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit alert

  2. Access permissions for required product

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

{ "resultCode": "SUCCESS", "resultMessage": "Alerts retrieved successfully, "result": { "alerts": [{ "isSystemHealthMetric": false, "isActive": false, "name": "API Error Message Count Alert", "description": "Alert when more than 10 API trans. ended with a specific error message", "productView": "APIC", "indexSets": "apic-log", "documentType": "APIC_LOGICAL_TRANS", "jsonQuery": "{\"_source\":{\"includes\":[\"apiName\",\"errorMessage\"]},... }", "jsonParameters": "{\"messageTextSubstring\":\"Failed to establish a backside connection\"}", "schedule": "", "recipients": [], "filtersParameters": { "timeRangeType": "recent",.....}, "lastUpdateTimeInMillis": 1646655197926, "lastUpdateUserName": "admin", "isPublishToMail": false, "isPublishToSyslog": false, "isPublishToMailWs": false, "errorThreshold": 10.0, "alertType": "Frequency", "comparator": "GreaterThan", "apiReference": "EDBD6F2B-A576-4619-AC63-2594A10F7EC6", "drillDownDashboardToken": "apicTransactions:" }, {....} ] } }

Status code: 200

resultCode → SUCCESS

resultMessage → “Alerts retrieved successfully"

 

GET Get Specific Alert Details

URL:

GET - https://{{dpodHostname}}/op/api/v2/alert/{{productView}}/{{alertApiReferenceId}}

Request - None.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Product view APIC / IDG

String

  • APIC

  • IDG

alertApiReferenceId

True

The alert apiReferenceId (can be retrieved from “Retrieved all alerts” response)

String

  • UUID (generated by default)

  • String chosen by user in edit/create alert

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit alert

  2. Access permissions for required product related to the alert

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

{ "resultCode": "SUCCESS", "resultMessage": "Alert retrieved successfully", "result": { "isSystemHealthMetric": <true/false>, "isActive": <true/false>, "name": "<alert name>", "description": "<alert description>", "productView": "<alert product view>", "indexSets": "<alert indexSet>", "documentType": "<alert documentType>", "jsonQuery": "{\"_source\":{\"includes\":[\"apiName\",... }", "jsonParameters": "<json parameters>", "schedule": "", "recipients": [], "filtersParameters": { "timeRangeType": "recent",.....}, "lastUpdateTimeInMillis": 1644768927839, "lastUpdateUserName": "Installer", "isPublishToMail": <true/false>, "isPublishToSyslog": <true/false>, "isPublishToMailWs": <true/false>, "errorThreshold": 10.0, "alertType": "<alert type>", "comparator": "<comparator>", "apiReference": "<alert uuid>", "drillDownDashboardToken": "<...>" } }

Status code: 200

resultCode → SUCCESS

resultMessage → “Alert retrieved successfully”

POST Execute (Async) Alert

URL:

POST - https://{{dpodHostname}}/op/api/v2/alert/{{productView}}/{{alertApiReferenceId}}/executeAsync

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Product view APIC / IDG

String

  • APIC

  • IDG

alertApiReferenceId

True

The alert apiReferenceId you wish to execute ( id can be retrieved from “Retrieved all alerts” response)

String

  • UUID (generated by default)

  • String chosen by user in edit/create alert

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit alert

  2. Access permissions for required product related to the alert

See roles information here: Role Based Access Control

Request body:

Type

Parameters

Example Json

Description

Type

Parameters

Example Json

Description

Required

  1. List<String> recipients

  2. Map<String, String>filtersParameters

  1. recipients → Recipients' email address. Array can be sent empty.

  2. filtersParameters→ List of filters. List can be sent empty.

 

Additional parameter

Available filters:

  1. deviceNameOp→

    1. “eq” for equal

    2. “ne” for unequitable

  2. filtersParameters→ List of filters. List can be sent empty.

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Alert executed successfully”

result → executionId → The alert execution id (integer).

 

GET Get Alert Execution Details

URL:

GET - https://{{dpodHostname}}/op/api/v2/alertexecution/{{productView}}/{{executionId}}

Request - None.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Relevant product view APIC / IDG

String

  • APIC

  • IDG

executionId

True

The alert execution ID (can be retrieved from “execute alert” api response)

String

The alert Id

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit alert

  2. Access permissions for required product related to the alert

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Alert retrieved successfully”

result →

  • executionId→ The alert execution ID

  • recipients→ Recipients' email address. Array can be sent empty.

  • filters→ List of filters. List can be sent empty.

  • executingUserName→ The user who executed this alert execution

  • status→ Alert execution status

  • requestTimeInMillis→ Request time in Millis

  • executionTimeInMillis→ Execution time in Millis

  • completionTimeInMillis→ Completion time in Millis

  • message →

    • "Execution finished with no alerts." - when no alerts found

    • "Execution finished with X alerts." - when X alerts found

Failure

 

Status code: 200

resultCode → ERROR

resultErrorCode → ALERT_NOT_FOUND

resultMessage → “Alert execution not found”

GET Download Alert Execution

URL:

GET - https://{{dpodHostname}}/op/api/v2/alertexecution/{{productView}}/{{executionId}}/download

Request - None.

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

Name

Is required

Description

Parameter Type

Data options

productView

True

Relevant product view APIC / IDG

String

  • APIC

  • IDG

executionId

True

The alert execution ID (can be retrieved from “execute alert” api response)

String

The alert Id

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. View or Edit alert

  2. Access permissions for required product related to the alert

See roles information here: Role Based Access Control

Response:

Response Type

Value

Description

Response Type

Value

Description

Successful

xls file type

Status code: 200

POST Duplicate Alert

POST Add Alert

PUT Edit Alert

DELETE Delete Alert

 

 

Related content

Alerts REST API
Alerts REST API
IBM DPOD v1.0.20.x
More like this
Alerts REST API
Alerts REST API
IBM DPOD v1.0.16.0
More like this
Alerts REST API
Alerts REST API
IBM DPOD v1.0.21.x
More like this
Alerts REST API
Alerts REST API
IBM DPOD v1.0.18.0
More like this
Alerts REST API
Alerts REST API
IBM DPOD v1.0.19.0
More like this
Alerts REST API
Alerts REST API
IBM DPOD v1.0.22.x
More like this

IBM DataPower Operations Dashboard (DPOD) v1.0.17.0