• Home
  • Dynatrace API
  • Configuration
  • Extensions
  • GET extension's states

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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GETManaged 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 an access token with Read configuration (ReadConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required extension.

pathrequired
pageSizeinteger

The number of results per result page. Must be between 1 and 500

queryoptional
nextPageKeystring

The cursor for the next page of results.

queryoptional
statestring

Extension state to filter.

The element can hold these values
  • DISABLED
  • ERROR_AUTH
  • ERROR_COMMUNICATION_FAILURE
  • ERROR_CONFIG
  • ERROR_TIMEOUT
  • ERROR_UNKNOWN
  • INCOMPATIBLE
  • LIMIT_REACHED
  • NOTHING_TO_REPORT
  • OK
  • STATE_TYPE_UNKNOWN
  • UNINITIALIZED
  • UNSUPPORTED
  • WAITING_FOR_STATE
queryoptional

Response

Response codes

CodeTypeDescription
200ExtensionStateList

Success

Response body objects

The ExtensionStateList object

A list of extension states.

ElementTypeDescription
statesExtensionState[]

A list of extension states.

Can be null.

totalResultsinteger

The total number of entries in the result.

Can be null.

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.

Can be null.

The ExtensionState object

The state of the extension.

ElementTypeDescription
extensionIdstring

The ID of the extension.

Can be null.

versionstring

The version of the extension (for example 1.0.0).

Can be null.

endpointIdstring

The ID of the endpoint where the state is detected - Active Gate only.

Can be null.

statestring

The state of the extension.

The element can hold these values
  • ERROR_AUTH
  • ERROR_COMMUNICATION_FAILURE
  • ERROR_CONFIG
  • ERROR_TIMEOUT
  • ERROR_UNKNOWN
  • INCOMPATIBLE
  • LIMIT_REACHED
  • NOTHING_TO_REPORT
  • OK
  • STATE_TYPE_UNKNOWN
  • UNINITIALIZED
  • UNSUPPORTED
  • WAITING_FOR_STATE

Can be null.

stateDescriptionstring

A short description of the state.

Can be null.

timestampinteger

The timestamp when the state was detected, in UTC milliseconds.

Can be null.

hostIdstring

The ID of the host on which the extension runs.

Can be null.

processIdstring

The ID of the entity on which the extension is active.

Can be null.

Response body JSON model

json
{ "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=" }
Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.