WAwatchguard
Get Comments for a Specific Incident

Retrieves a list of comments for an incident.

Retrieves a list of comments for a specific incident.

get/v1/{accountId}/incidents/{incidentId}/comments

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud Account ID.

incidentIdstring required

ID of an incident.

Query parameters

sortOrderstring

Specifies whether to sort the results in ascending or descending order. This can be one of these values:

  • asc - Sorts results in ascending order.
  • desc - Sorts results in descending order.
sortBystring

Specifies how to sort results. This can be the names of one or more response parameters, separated by commas.

fieldsstring

Specifies which response parameters to return in the results. If you do not specify a value, the API returns all response parameters. This can be the names of one or more response parameters, separated by commas.

limitinteger

Maximum number of records to retrieve in the response. The maximum is limited to 500 records. The default value is 250.

durationstring

Duration of time in days to retrieve records for. Specify a number followed by the letter D. For example, 7D.

startAfterstring

Cursor value that identifies the record after which you want to retrieve records. This value must match the data returned in the response parameter you specify in the sortBy request parameter.

groupBystring

Specifies the response parameter to group data by.

Response

Successful response.

countinteger

Total count of actions.

Example response

{
  "items": [
    {
      "id": "903b824302b4419cac6ac4b0ead6719d",
      "incidentId": "cq7m4paoksm0rb2o46ag",
      "account": "WCG-1-123abc456 or ACC-1234567",
      "user": "xdradmin",
      "comment": "sample comment",
      "creationTime": "2023-09-27T06:44:34Z"
    }
  ],
  "count": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.