Alert Comments

REST API operation for alert comments

Overview

The /alert-comments REST API operations are in open beta starting with Panther version 1.112, and are available to all customers. Please share any bug reports and feature requests with your Panther support team.

Use these API operations to interact with alert comments in Panther.

To call the API, see the How to use the Panther REST API instructions—including directions for how to invoke it directly from this documentation page.

Required permissions

• For GET operations, your API token must have the Read Alerts permission.

• For POST operations, your API token must have the Manage Alerts permission.

Operations

Create a comment for an alert

post

Authorizations

Body

alertIdstringrequired

The alert ID the comment is associated with

bodystringrequired

The body of the comment

formatstring · enumrequired

The format of the comment

Available options:

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-api-host/alert-comments' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "alertId": "text",
    "body": "text",
    "format": "PLAIN_TEXT"
  }'

200

400

404

200

{
  "alertId": "text",
  "body": null,
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "format": "PLAIN_TEXT",
  "id": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  }
}

OK response.

Get a comment for an alert

get

Authorizations

Path parameters

idstringrequired

ID of the comment

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-api-host/alert-comments/{id}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

400

404

200

{
  "alertId": "text",
  "body": null,
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "format": "PLAIN_TEXT",
  "id": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  }
}

OK response.

Update a comment for an alert

post

Authorizations

Path parameters

idstringrequired

ID of the comment

Body

alertIdstringrequired

The alert ID the comment is associated with

bodystringrequired

The body of the comment

formatstring · enumrequired

The format of the comment

Available options:

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-api-host/alert-comments/{id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "alertId": "text",
    "body": "text",
    "format": "PLAIN_TEXT"
  }'

200

400

404

200

{
  "alertId": "text",
  "body": null,
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "format": "PLAIN_TEXT",
  "id": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  }
}

OK response.

List alert comments

get

Authorizations

Query parameters

alert-idstringrequired

The alert ID the comments are associated with

cursorstringoptional

the pagination token

limitinteger · int64 · max: 50optional

the maximum results to return

Default: 25

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-api-host/alert-comments?alert-id=text' \
  --header 'X-API-Key: YOUR_API_KEY'

200

400

200

{
  "next": "text",
  "results": [
    {
      "alertId": "text",
      "body": null,
      "createdAt": "text",
      "createdBy": {
        "id": "user",
        "type": "text"
      },
      "format": "PLAIN_TEXT",
      "id": "text",
      "updatedAt": "text",
      "updatedBy": {
        "id": "user",
        "type": "text"
      }
    }
  ]
}

OK response.