List monitoring configurations for an Extension 2.0 in Dynatrace with the Extensions 2.0 API, and page or filter the results.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/extensions/v2/extensions/{extension-name}/monitoring-configurations |
You provide the extension-name path parameter and can use page-size, page-key, and filter to control the monitoring configurations returned. The operation returns a success response with the configuration list.
To execute this request, you need a platform token or OAuth access token with extensions:configurations:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| page-size | integer | The amount of monitoring configurations in a single response payload. The maximal allowed page size is 500. If not set, 20 is used. | query | Optional |
| page-key | string | The cursor for the next page of results. You can find it in the next-page-key field of the previous response. The first page is always returned if you don't specify the page-key query parameter. When the page-key is set to obtain subsequent pages, you must omit all other query parameters. | query | Optional |
| extension-name | string | The name of the requested Extension 2.0. | path | Required |
| filter | string | The filter parameter, as explained here. Filtering is supported on the following fields:
| query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Extension | Success. |
| 4XX | Error | Client error. |
| 5XX | Error | Server error. |
ExtensionMonitoringConfigurationList object| Element | Type | Description |
|---|---|---|
| items | Extension | A list of extension monitoring configurations. |
| nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the page-key query parameter to obtain subsequent pages of the result. |
| pageSize | integer | The number of entries per page. |
| totalCount | integer | - |
ExtensionMonitoringConfiguration objectA list of extension monitoring configurations.
| Element | Type | Description |
|---|---|---|
| modificationInfo | Modification | Audit information about the creation and modification of this resource |
| objectId | string | Configuration id |
| scope | string | Configuration scope |
| value | object | Configuration |
ModificationInfo objectAudit information about the creation and modification of this resource
| Element | Type | Description |
|---|---|---|
| createdBy | string | User who created the configuration |
| createdTime | string | Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| lastModifiedBy | string | User who last modified the configuration |
| lastModifiedTime | string | Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code. |
| details | Error | The error details. |
| message | string | The error message. |
ErrorDetails objectThe error details.
| Element | Type | Description |
|---|---|---|
| constraintViolations | Constraint | A list of constraint violations. |
ConstraintViolation objectA list of constraint violations.
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"items": [{"modificationInfo": {"createdBy": "string","createdTime": "string","lastModifiedBy": "string","lastModifiedTime": "string"},"objectId": "string","scope": "string","value": {}}],"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 1,"totalCount": 1}
{"error": {"code": 1,"details": {"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}]},"message": "string"}}