Extensions API - GET states of an extension
Lists the endpoint states of the specified extension.
States are stored in server memory and are cleared with restart.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/states |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/states | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/states |
Authentication
To execute this request, you need Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required extension. | path | required |
| pageSize | integer | The number of results per result page. Must be between 1 and 500 | query | optional |
| nextPageKey | string | The cursor for the next page of results. | query | optional |
| state | string | Extension state to filter. | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Extension | Success |
Response body objects
The ExtensionStateList object
A list of extension states.
| Element | Type | Description | Required |
|---|---|---|---|
| states | Extension | A list of extension states. | optional |
| totalResults | integer | The total number of entries in the result. | optional |
| 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. | optional |
The ExtensionState object
The state of the extension.
| Element | Type | Description | Required |
|---|---|---|---|
| extensionId | string | The ID of the extension. | optional |
| version | string | The version of the extension (for example | optional |
| endpointId | string | The ID of the endpoint where the state is detected - Active Gate only. | optional |
| state | string | The state of the extension. | optional |
| stateDescription | string | A short description of the state. | optional |
| timestamp | integer | The timestamp when the state was detected, in UTC milliseconds. | optional |
| hostId | string | The ID of the host on which the extension runs. | optional |
| processId | string | The ID of the entity on which the extension is active. | optional |
Response body JSON model
{
"states": [
{
"extensionId": "custom.python.connectionpool",
"version": "1.82",
"endpointId": "null",
"state": "OK",
"stateDescription": "",
"timestamp": 1578578108213,
"hostId": "HOST-01A7DEFA5340A86D",
"processId": "PROCESS_GROUP_INSTANCE-2182DF2E20E3E067"
}
],
"totalResults": 9,
"nextPageToken": "LlUdYmu5S2MfX/ppfCInR9M="
}