Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Alerts

Create alert

The endpoint allows users to programmatically generate alerts with customized parameters. It integrates with existing systems to transform raw data into actionable alerts, ensuring timely notifications for incident management.

post/api/{cloudId}/v1/alerts

Request body

messagestring required

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

notestring

Additional context or information about the alert that isn't captured in other fields. This could include steps taken to address the alert, details about the potential cause, or other relevant information.

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>.

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.

tagsstring[]

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

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.

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.

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.

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.

Example request

{
  "message": "The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.",
  "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"
    }
  ],
  "visibleTo": [
    {
      "id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c",
      "type": "team"
    },
    {
      "id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8",
      "type": "user"
    }
  ],
  "note": "This server has experienced high CPU usage multiple times in the past week. A server upgrade has been recommended to prevent future occurrences.",
  "alias": "DatabaseConnectionFailure_DatabaseServer1",
  "entity": "DatabaseServer1",
  "source": "DBMonitoringTool",
  "tags": [
    "OverwriteQuietHours",
    "Critical"
  ],
  "actions": [
    "RestartServer"
  ],
  "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.",
  "extraProperties": {
    "backend": false,
    "browser": "Firefox 113.0",
    "browser.name": "Firefox",
    "bundler": "parcel@2.10.3",
    "environment": "production"
  }
}

Response

Returned if the request is successful.

resultstring

Indicates the outcome of the request.

requestIdstring

Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.

tookinteger

Example response

{
  "result": "Request will be processed",
  "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777"
}