• Home
  • Dynatrace API
  • Environment
  • Problems v2
  • Problems
  • POST close a problem

Problems API v2 - POST close a problem

Closes the specified problem and adds the closing comment.

The request consumes and produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/close
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close

Authentication

To execute this request, you need an access token with problems.write scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
problemIdstring

The ID of the required problem.

pathrequired
bodyProblemCloseRequestDtoImpl

The JSON body of the request. Contains the closing comment on the problem.

bodyoptional

Request body objects

The ProblemCloseRequestDtoImpl object

ElementTypeDescriptionRequired
messagestring

The text of the closing comment.

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "message": "string" }

Response

Response codes

CodeTypeDescription
200ProblemCloseResult

Success

204

The problem is closed already the request hasn't been executed.

Response body objects

The ProblemCloseResult object

The result of closing a problem.

ElementTypeDescription
closeTimestampinteger

The timestamp when the user triggered the closing.

problemIdstring

The ID of the problem.

closingboolean

True, if the problem is being closed.

commentComment

The comment to a problem.

The Comment object

The comment to a problem.

ElementTypeDescription
authorNamestring

The user who wrote the comment.

createdAtTimestampinteger

The timestamp of comment creation, in UTC milliseconds.

contextstring

The context of the comment.

idstring

The ID of the comment.

contentstring

The text of the comment.

Response body JSON model

json
{ "closeTimestamp": 1, "problemId": "string", "closing": true, "comment": { "authorName": "string", "createdAtTimestamp": 1, "context": "string", "id": "string", "content": "string" } }
Related topics
  • Davis® AI

    Get familiar with the capabilities of Davis AI.