Extensions 2.0 API - GET all monitoring configurations
Lists all monitoring configurations of the specified Extensions 2.0 extension.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/monitoringConfigurations | |
Environment and Cluster ActiveGate (default port 9999) | https://{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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
nextPageKey | string | 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. | query | optional |
pageSize | integer | The amount of extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. | query | optional |
extensionName | string | The name of the requested extension 2.0. | path | required |
version | string | Filters the resulting set of configurations by extension 2.0 version. | query | optional |
active | boolean | Filters the resulting set of configurations by the active state. | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | ExtensionMonitoringConfigurationsList | Success |
400 | ErrorEnvelope | Failed. The input is invalid. |
404 | ErrorEnvelope | Failed. The requested resource doesn't exist. |
Response body objects
The ExtensionMonitoringConfigurationsList
object
Element | Type | Description |
---|---|---|
items | ExtensionMonitoringConfiguration[] | A list of extension monitoring configurations. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
pageSize | integer | The number of entries per page. |
totalCount | integer | The total number of entries in the result. |
The ExtensionMonitoringConfiguration
object
Element | Type | Description |
---|---|---|
objectId | string | Configuration id |
scope | string | Configuration scope |
value | object | Configuration |
Response body JSON model
1{2 "items": [3 {4 "objectId": "string",5 "scope": "string",6 "value": {}7 }8 ],9 "nextPageKey": "AQAAABQBAAAABQ==",10 "pageSize": 1,11 "totalCount": 112}