Extensions 2.0 API - GET all monitoring configurations

  • Reference

Lists all monitoring configurations 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
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations

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
nextPageKeystring

The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.

The first page is always returned if you don't specify the nextPageKey query parameter.

When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.

queryoptional
pageSizeinteger

The amount of extensions in a single response payload.

The maximal allowed page size is 100.

If not set, 20 is used.

queryoptional
extensionNamestring

The name of the requested extension 2.0.

pathrequired
versionstring

Filters the resulting set of configurations by extension 2.0 version.

queryoptional
activeboolean

Filters the resulting set of configurations by the active state.

queryoptional

Response

Response codes

CodeTypeDescription
200ExtensionMonitoringConfigurationsList

Success

400ErrorEnvelope

Failed. The input is invalid.

404ErrorEnvelope

Failed. The requested resource doesn't exist.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ExtensionMonitoringConfigurationsList object

ElementTypeDescription
itemsExtensionMonitoringConfiguration[]

A list of extension monitoring configurations.

nextPageKeystring

The cursor for the next page of results. Has the value of null on the last page.

Use it in the nextPageKey query parameter to obtain subsequent pages of the result.

pageSizeinteger

The number of entries per page.

totalCountinteger

The total number of entries in the result.

The ExtensionMonitoringConfiguration object

ElementTypeDescription
objectIdstring

Configuration id

scopestring

Configuration scope

valueobject

Configuration

Response body JSON model

{
  "items": [
    {
      "objectId": "string",
      "scope": "string",
      "value": {}
    }
  ],
  "nextPageKey": "AQAAABQBAAAABQ==",
  "pageSize": 1,
  "totalCount": 1
}