ATatlassian
Alerts

List alert notes

This endpoint is used to retrieve a list of notes for a specified alert. Notes provide additional information or context about an alert, helping to enhance the understanding and management of alerts.

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

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/alerts/{id}/notes
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: read:ops-alert:jira-service-management

Path parameters

idstring required

Identifier of the alert.

Query parameters

afterstring

This parameter is used in pagination for the alert notes. It accepts a string key of the last record from the previous page. The system will return the next page of notes that come after this specified key. This is useful for fetching subsequent segments of data when there are more notes than the size specified.

sizeinteger

This parameter is used to limit the number of alert notes returned by the system. It accepts an integer that specifies the maximum number of notes to be retrieved.

Response

Returned if the request is successful.

Example response

{
  "values": [
    {
      "id": "1704869443312000050",
      "createdAt": "2024-01-05T07:06:47.958Z",
      "updatedAt": "2024-01-05T07:06:47.958Z",
      "note": "System downtime expected due to maintenance activities.",
      "owner": "user@atlassian.com"
    }
  ],
  "links": {
    "next": "/v1/alerts/4513b7ea-3b91-438f-b7e4-e3e54af9147c/notes?after=1492000072838"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.