Try it free

Extensions 2.0 API - GET the status of a monitoring configuration

  • Reference
  • Published Jun 29, 2021

Gets the most recent execution of a monitoring configuration.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status
GETEnvironment and Cluster ActiveGate (default port 9999)https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/status

Authentication

Api-Token:

To execute this request, you need an access token with extensionConfigurations.read scope.

One of the following permissions is required for personal access tokens:

  • environment:roles:manage-settings
  • extensions:configurations:read

To learn how to obtain and use it, see Personal access tokens.

Platform Token / OAuth:

Required scope: extensions:configurations:read

To learn how to obtain and use it, see Platform tokens or OAuth clients.

Parameters

ParameterTypeDescriptionInRequired
extensionNamestring

The name of the requested extension 2.0.

pathRequired
configurationIdstring

The ID of the requested monitoring configuration.

pathRequired

Response

Response codes

CodeTypeDescription
200ExtensionStatusDto

Success

404ErrorEnvelope

Failed. The requested resource doesn't exist.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ExtensionStatusDto object

ElementTypeDescription
statusstring

Latest status of given configuration.

The element can hold these values
  • ERROR
  • OK
  • PENDING
  • UNKNOWN
  • WARNING
timestampinteger

Timestamp of the latest status of given configuration.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
"status": "ERROR",
"timestamp": 1
}
{
"error": {
"code": 1,
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
],
"message": "string"
}
}

Related topics

  • Develop your own Extensions