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.

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

Authentication

To execute this request, you need the 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.

The state element can hold these values.
query optional

Possible values

Possible values for the state element:

  • 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

Response format

The ExtensionStateList object

A list of extension states.

Element Type Description
states ExtensionState[]

A list of extension states.

totalResults integer

The total number of entries in the result.

nextPageKey string

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.

The ExtensionState object

The state of the extension.

Element Type Description
extensionId string

The ID of the extension.

version string

The version of the extension (for example 1.0.0).

endpointId string

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

state string

The state of the extension.

The state element can hold these values.
stateDescription string

A short description of the state.

timestamp integer

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

hostId string

The ID of the host on which the extension runs.

processId string

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

Possible values

Possible values for the state element in the ExtensionState object:

  • 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