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.

This request is in beta and may be changed in non compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/states
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/states

Parameters

Parameter Type Description In Required
id string

The ID of the required plugin.

path required

Response format

The PluginStateList object

A list of plugin states.

Element Type Description
states PluginState[]

A list of plugin states.

The PluginState object

The state of the plugin.

Element Type Description
pluginId string

The ID of the plugin.

version string

The version of the plugin (for example 1.0.0).

endpointId string

The ID of the endpoint where the state is detected.

state string

The state of the plugin.

stateDescription string

A short description of the state.

timestamp integer

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

Example

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

Curl

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

Request URL

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

Response body

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

Response code

200