Problems API - POST a comment

We have a new version of this API—Problems API v2. Check it out!

Adds a comments to the specified problem.

The request consumes and produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/problem/details/{problemId}/comments
  • SaaS https://{your-environment-id}{problemId}/comments
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/problem/details/{problemId}/comments


To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
problemId string

The ID of the problem where you want to add the comment.

path required
body PushProblemComment

JSON body of the request, containing the comment.

body optional

Body format

The PushProblemComment object

A comment of a problem

Element Type Description Required
comment string

A comment on the problem.

user string

The author of the comment.

context string

The context of the comment. It can contain any additional information.



Response codes

Code Description


Response body

The ProblemComment object

The comment to the problem.

Element Type Description
id string

The ID of the comment.

createdAtTimestamp integer

The timestamp of the comment creation, in UTC milliseconds.

content string

The text of the comment.

userName string

The author of the comment.

context string

The context of the comment.

Could be any textual comment. You can only set it via REST API.


In this example, the request adds a new comment on the problem with ID 2307087411653364173_1538400720000V2.

The API token is passed in the Authorization header.


curl -X POST \ \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \  
  -d '{
  "comment": "This one is probably caused by network",
  "user": "john.smith",
  "context": "Slack"

Request URL

Request body

  "comment": "This one is probably caused by network",
  "user": "john.smith",
  "context": "Slack"

Response body

    "id": "-6026872125973307382_1538400720000",
    "createdAtTimestamp": 1538559856030,
    "content": "This one is probably caused by network",
    "userName": "john.smith",
    "context": "Slack"

Response code