• Home
  • Dynatrace API
  • Configuration
  • Plugins
  • GET states of a plugin

Plugins API - GET states of an ActiveGate plugin

Lists the endpoint states of the specified plugin.

States are stored in server memory and are cleared with restart.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/states
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/states
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/states

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required plugin.

pathrequired

Response

Response codes

CodeTypeDescription
200PluginStateList

Success

Response body objects

The PluginStateList object

A list of plugin states.

ElementTypeDescription
statesPluginState[]

A list of plugin states.

The PluginState object

The state of the plugin.

ElementTypeDescription
pluginIdstring

The ID of the plugin.

versionstring

The version of the plugin (for example 1.0.0).

endpointIdstring

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

statestring

The state of the plugin.

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
stateDescriptionstring

A short description of the state.

timestampinteger

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

hostIdstring

The ID of the host on which the plugin runs.

processIdstring

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

Response body JSON model

json
{ "pluginId": "custom.remote.python.demo", "version": "1.0.0", "endpointId": "-8213819843595439277", "state": "ERROR_AUTH", "stateDescription": "Could not authorize", "timestamp": 1556199097994 }

Example

In this example, the request lists the states of the MathPlugin, which has the ID of custom.remote.python.simple_math.

Curl

bash
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.simple_math/states \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.simple_math/states

Response body

json
{ "states": [ { "pluginId": "custom.remote.python.simple_math", "version": "1.02", "endpointId": "575712901374982783", "state": "OK", "stateDescription": "", "timestamp": 1560343244178 } ] }

Response code

200