Problems API - POST close

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

Closes the specified problem and adds the closing comment.

The request consumes and produces an application/json payload.

POST

Managed https://{your-domain}/e/{your-environment-id}/api/v1/problem/details/{problemId}/close
SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/problem/details/{problemId}/close
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/problem/details/{problemId}/close

Authentication

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.

Parameters

Parameter	Type	Description	In	Required
problemId	string	The ID of the problem to be closed.	path	required
content	string	The closing comment.	query	optional

Response

Response codes

Code	Description
200	Success

Response body

Response parametersJSON model

The ProblemCloseResult object

The result of closing a problem.

Element	Type	Description
problemId	string	The ID of the problem.
comment	ProblemComment
closeTimestamp	integer	The timestamp when the closure was triggered.
closing	boolean	The problem is in process of closing (`true`) or closed (`false`).

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.

    {
  "problemId": "string",
  "comment": {
    "id": "string",
    "createdAtTimestamp": 1,
    "content": "string",
    "userName": "string",
    "context": "string"
  },
  "closeTimestamp": 1,
  "closing": true
}