Problems API - POST close
This API is deprecated. Use the Problems API v2 instead.
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 an access token with Access problem and event feed, metrics, and topology (DataExport
) scope. 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 | 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 |
---|---|---|
problemId | string | The ID of the problem. |
comment | Problem | The comment to the problem. |
closeTimestamp | integer | The timestamp when the closure was triggered. |
closing | boolean | The problem is in process of closing ( |
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. |
Response body JSON model
{
"problemId": "string",
"comment": {
"id": "string",
"createdAtTimestamp": 1,
"content": "string",
"userName": "string",
"context": "string"
},
"closeTimestamp": 1,
"closing": true
}