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 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 | optional |
| content | string | The closing comment. | query | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Problem | Success |
Response body objects
The ProblemCloseResult object
The result of closing a problem.
| Element | Type | Description | Required |
|---|---|---|---|
| problemId | string | The ID of the problem. | optional |
| comment | Problem | The comment to the problem. | optional |
| closeTimestamp | integer | The timestamp when the closure was triggered. | optional |
| closing | boolean | The problem is in process of closing ( | optional |
The ProblemComment object
The comment to the problem.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the comment. | optional |
| createdAtTimestamp | integer | The timestamp of the comment creation, in UTC milliseconds. | optional |
| content | string | The text of the comment. | optional |
| userName | string | The author of the comment. | optional |
| context | string | The context of the comment. Could be any textual comment. You can only set it via REST API. | optional |
Response body JSON model
{
"problemId": "string",
"comment": {
"id": "string",
"createdAtTimestamp": 1,
"content": "string",
"userName": "string",
"context": "string"
},
"closeTimestamp": 1,
"closing": true
}