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 theRead Alerts
permission.For
POST
operations, your API token must have theManage Alerts
permission.
Operations
Authorizations
Body
alertIdstringRequired
The alert ID the comment is associated with
bodystringRequired
The body of the comment
formatstring · enumRequiredPossible values:
The format of the comment
Responses
200
OK response.
application/json
400
bad_request: Bad Request response.
application/json
404
not_found: Not Found response.
application/json
post
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"
}
}
Authorizations
Path parameters
idstringRequired
ID of the comment
Responses
200
OK response.
application/json
400
bad_request: Bad Request response.
application/json
404
not_found: Not Found response.
application/json
get
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"
}
}
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 · enumRequiredPossible values:
The format of the comment
Responses
200
OK response.
application/json
400
bad_request: Bad Request response.
application/json
404
not_found: Not Found response.
application/json
post
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"
}
}
Authorizations
Query parameters
alert-idstringRequired
The alert ID the comments are associated with
cursorstringOptional
the pagination token
limitinteger · int64 · max: 50OptionalDefault:
the maximum results to return
25
Responses
200
OK response.
application/json
400
bad_request: Bad Request response.
application/json
get
GET /alert-comments 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"
}
}
]
}
Last updated
Was this helpful?