v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Alerts

List alerts

This endpoint is designed to provide a comprehensive view of all alerts in your system. This API supports pagination and filtering with allowing you to customize the view based on your specific needs. More than 20000 alerts cannot be retrieved. Sum of offset and size should be lower than 20K.

get/api/{cloudId}/v1/alerts

Query parameters

sizeinteger

Maximum number of items to provide in the result.

sort'createdAt' | 'insertedAt' | 'lastOccurredAt' | 'priority'

Name of the field that result set will be sorted by.

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

order'asc' | 'desc'

Sorting order of the result set.

querystring

This parameter is used to filter the alerts based on specified criteria. It accepts a string value that represents the search query. This parameter provides a powerful way to retrieve alerts that meet certain conditions or contain specific information. You can refer <a target="_self" href="https://operations-help.atlassian.net/wiki/spaces/OPSHELP/pages/8028374/Search+syntax+for+alerts">Alerts Search Query Help</a> for further information about search queries.

frominteger

The starting date-time to consider while filtering the alerts. It helps in narrowing down the list of alerts to a specific time frame.

tointeger

The ending date-time to consider while filtering the alerts. Used in conjunction with 'from', it defines the specific time window to focus on for the alert listing.

Response

Returned if the request is successful.

countinteger

Total number of alerts.

Example response

{
  "values": [
    {
      "id": "e0caa0ce-d52f-4500-81b9-d592d06970b6",
      "tinyId": "1234",
      "createdAt": "2024-01-05T07:06:47.958Z",
      "updatedAt": "2024-01-05T07:06:47.958Z",
      "message": "The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.",
      "entity": "DatabaseServer1",
      "source": "DBMonitoringTool",
      "status": "closed",
      "alias": "DatabaseConnectionFailure_DatabaseServer1",
      "tags": [
        "OverwriteQuietHours",
        "Critical"
      ],
      "extraProperties": {
        "backend": false,
        "browser": "Firefox 113.0",
        "browser.name": "Firefox",
        "bundler": "parcel@2.10.3",
        "environment": "production"
      },
      "description": "The alert is triggered due to the high CPU usage on Server XYZ. The CPU usage has consistently been above 80% for more than 5 minutes which could potentially lead to server slowdown or even a crash. Suggested action is to investigate the processes consuming high CPU and optimize or terminate them as needed. If the issue persists, consider upgrading the server resources.",
      "acknowledged": true,
      "ackTime": "2024-01-05T07:08:47.958Z",
      "closeTime": "2024-01-05T09:06:47.958Z",
      "count": 3,
      "owner": "John Smith",
      "snoozedUntil": "2022-05-01T00:00:00Z",
      "lastOccuredAt": "2022-04-01T00:00:00Z",
      "integrationType": "API",
      "integrationName": "Default API",
      "responders": [
        {
          "id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c",
          "type": "team"
        },
        {
          "id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8",
          "type": "user"
        },
        {
          "id": "aee8a0de-c80f-4515-a232-501c0bc9d715",
          "type": "escalation"
        },
        {
          "id": "80564037-1984-4f38-b98e-8a1f662df552",
          "type": "schedule"
        }
      ],
      "actions": [
        "RestartServer"
      ],
      "seen": true
    }
  ],
  "count": 1,
  "links": {
    "next": "/v1/alerts?offset=10&size=5"
  }
}