Alert Comments

REST API operation for alert comments

Overview

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

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

alertIdstringRequired

The alert ID the comment is associated with

bodystringRequired

The body of the comment

formatstring · enumRequired

The format of the comment

Possible values:

Responses

200

OK response.

application/json

alertIdstringOptional

The alert ID the comment is associated with

bodyanyOptional

The body of the comment

createdAtstringOptional

The date the comment was created

formatstring · enumOptional

The format of the comment

Possible values:

idstringOptional

The comment ID

updatedAtstringOptional

The date the comment was updated

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/alert-comments

HTTPcURLJavaScriptPython

POST /alert-comments HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "alertId": "text",
  "body": "text",
  "format": "PLAIN_TEXT"
}

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

Get a comment for an alert

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the comment

Responses

200

OK response.

application/json

alertIdstringOptional

The alert ID the comment is associated with

bodyanyOptional

The body of the comment

createdAtstringOptional

The date the comment was created

formatstring · enumOptional

The format of the comment

Possible values:

idstringOptional

The comment ID

updatedAtstringOptional

The date the comment was updated

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

get

/alert-comments/{id}

HTTPcURLJavaScriptPython

GET /alert-comments/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

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

Update a comment for an alert

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the comment

Body

application/json

alertIdstringRequired

The alert ID the comment is associated with

bodystringRequired

The body of the comment

formatstring · enumRequired

The format of the comment

Possible values:

Responses

200

OK response.

application/json

alertIdstringOptional

The alert ID the comment is associated with

bodyanyOptional

The body of the comment

createdAtstringOptional

The date the comment was created

formatstring · enumOptional

The format of the comment

Possible values:

idstringOptional

The comment ID

updatedAtstringOptional

The date the comment was updated

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/alert-comments/{id}

HTTPcURLJavaScriptPython

POST /alert-comments/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "alertId": "text",
  "body": "text",
  "format": "PLAIN_TEXT"
}

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

List alert comments

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

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

200

OK response.

application/json

nextstringOptional

Pagination token for the next page of results

400

bad_request: Bad Request response.

application/json

get

/alert-comments

HTTPcURLJavaScriptPython

GET /alert-comments?alert-id=text HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

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