Problems API - POST close a problem

Closes the specified problem and adds the closing comment.

The request consumes and produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close
  • SaaS https://{your-environment-id}{problemId}/close


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 you're closing.

path required
body ProblemCloseRequestDtoImpl

The request payload for closing a comment.

body optional

The ProblemCloseRequestDtoImpl object

Element Type Description Required
message string

The content of the closing comment.


Response format

The ProblemCloseResult object

The result of closing a problem.

Element Type Description
closing boolean

True, if the problem is being closed.

closeTimestamp integer

The timestamp when the user triggered the closing.

problemId string

The ID of the problem.

comment CommentDto

The CommentDto object

Element Type Description
createdAtTimestamp integer
authorName string
context string
id string
content string