Extensions 2.0 API - GET a monitoring configuration

  • Reference
  • Published Apr 07, 2021

Gets the monitoring configuration of the specified Extensions 2.0 extension.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}

Authentication

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

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

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
200ExtensionMonitoringConfiguration

Success

404ErrorEnvelope

Failed. The requested resource doesn't exist.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ExtensionMonitoringConfiguration object

ElementTypeDescription
objectIdstring

Configuration id

scopestring

Configuration scope

valueobject

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

{
  "objectId": "string",
  "scope": "string",
  "value": {}
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}