v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Alerts

Get alert

This endpoint provides users the ability to retrieve comprehensive details of a specific alert using its unique id.

get/api/{cloudId}/v1/alerts/{id}

Path parameters

idstring required

Identifier of the alert.

Response

Returned if the request is successful.

idstring

Identifier of alert.

tinyIdstring

Unique, system-generated identification code assigned to each alert. This ID is shorter and simpler than the primary alert ID, making it easier to reference in communications and operations. It serves as a quick reference point to uniquely identify each alert.

createdAtstring date-time

Exact date and time when the alert was generated. It helps in tracking the timeline of the alerts and understanding the chronology of events.

updatedAtstring date-time

Exact date and time when the alert was updated.

messagestring

Brief summary of the alert that provides enough information to understand the nature of the issue at a glance.

entitystring

Entity that the alert is related to. It could be a server, service, application or another source that's being monitored. The 'entity' helps in identifying and categorizing the origin of the alert, enabling quicker diagnostics and resolution of the issue.

sourcestring

Origin of the alert, i.e., the system or application where the alert was generated. This field is useful for tracking and sorting alerts according to their originating sources, which can help in troubleshooting and determining the cause of the alerts.

status'open' | 'acked' | 'resolved' | 'snoozed' | 'closed'

Current state of the alert represents whether the alert is new, has been acknowledged by a team member, has been resolved etc.

aliasstring

Client-defined identifier of the alert, that is also the key element of <a target="_self" href="https://support.atlassian.com/atlassian/docs/what-is-alert-de-duplication/">Alert De-Duplication</a>.

tagsstring[]

Additional categorizing information. These tags can then be used for searching or grouping alerts, making it easier to manage and prioritize them.

extraPropertiesExtraProperties

Map of key-value pairs to use as custom properties of the alert. This can include context-specific data, diagnostic information, or other metadata that can assist in understanding and resolving the alert.

descriptionstring

Detailed information contains more comprehensive information than the 'message' field, including the implications of the alert, steps to reproduce the issue, or suggestions for resolving the problem. It serves as a guide for the person or team responding to the alert to better understand the situation and take appropriate actions.

acknowledgedboolean

Indicating whether the alert has been acknowledged by a team member or not. If the alert has been acknowledged, it means that someone is actively looking into the issue.

ackTimestring date-time

Exact date and time when the alert was acknowledged.

closeTimestring date-time

Exact date and time when the alert was closed.

countinteger

Represents the number of times the alert has been triggered. Each time the same alert is triggered, instead of creating a new alert, the count of the existing alert increases. This helps in reducing noise and focusing on the recurring issue.

ownerstring

Display name of the alert owner.

snoozedboolean

Reflects whether the alert has been temporarily silenced or not. If set to 'true', it means the alert notifications have been paused for a specified duration and will not disturb the users during this period.

snoozedUntilstring date-time

Represents the time until which the alert is snoozed.

lastOccuredAtstring date-time

Represents the most recent time the alert was triggered.

integrationTypestring

Denotes the type of integration used to create the alert.

integrationNamestring

Denotes the name of integration used to create the alert.

priority'P1' | 'P2' | 'P3' | 'P4' | 'P5'

Urgency level of the alert. The priority can be set as 'P1', 'P2', 'P3', 'P4', or 'P5', with 'P1' being the highest and 'P5' the lowest. The 'priority' attribute aids in effective alert management by allowing alerts to be categorized and handled according to their importance.

actionsstring[]

A list of actions that can be executed on the alert. These actions are custom to your organization and can be used to automate responses to specific alerts.

seenboolean

Represents whether the alert has been viewed by a user or not.

Example response

{
  "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
}