Get Alerts

Get Alerts

Example: GET /api/alerts?id={id1}&id={id2}&resourceId={resId1}&resourceId={resId2}

Request
URI
GET
https://{api_host}/suite-api/api/alerts
COPY
Query Parameters
string of array
id
Optional

Identifiers of the Alerts

string of array
resourceId
Optional

Identifiers of the Resources whose Alerts you need to be looked up

integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page

Authentication
This operation uses the following authentication methods.
Responses
200

Alerts matching the specified identifiers. Can be empty

Returns alerts of type(s) application/json 
"{\n  \"alerts\" : [ {\n    \"alertId\" : \"31eeaeec-82d5-4037-a59b-efed2e7c8e3a\",\n    \"resourceId\" : \"fb42f6c4-ab67-4ec2-8d76-5079876a03f0\",\n    \"alertLevel\" : \"NONE\",\n    \"startTimeUTC\" : 1744473857,\n    \"cancelTimeUTC\" : 0,\n    \"updateTimeUTC\" : 1744483857,\n    \"suspendUntilTimeUTC\" : 0\n  }, {\n    \"alertId\" : \"18589dea-9999-1234-abba-f1ee73004dac\",\n    \"resourceId\" : \"78b08fb3-58e5-42c9-87b8-ed92ef11aff7\",\n    \"alertLevel\" : \"NONE\",\n    \"startTimeUTC\" : 1744473857,\n    \"cancelTimeUTC\" : 0,\n    \"updateTimeUTC\" : 1744483857,\n    \"suspendUntilTimeUTC\" : 0\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
alerts
Optional

List of alerts


500

Error occurred while retrieving the Alert with the specified identifier

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/alerts
On This Page
Alerts Operations
GET
Get Alert Definitions
PUT
Update Alert Definition
POST
Create Alert Definition
PUT
Enable Alert Definition In Policies
PUT
Disable Alert Definition In Policies
GET
Get Alerts
POST
Modify Alerts
GET
Get Alert Notes
POST
Add Alert Note
POST
Query Alert
POST
Query Alert Notes
POST
Query Alert Groups
POST
Query Alert Definitions
GET
Get Alert
GET
Get Alert Note
DELETE
Delete Alert Note
GET
Get Alert Types
GET
Get Alert Contributing Symptoms
GET
Get Alert Definition By Id
DELETE
Delete Alert Definition
DELETE
Delete Canceled Alerts