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

Plugins API - GET a plugin

Lists the properties of the specified plugin.

The request produces an application/json payload.

GETManaged https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}

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 plugin.

pathrequired

Response

Response codes

CodeTypeDescription
200Plugin

Success

Response body objects

The Plugin object

General configuration of a plugin.

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

Can be null.

idstring

The ID of the plugin, for example custom.remote.python.demo.

Can be null.

namestring

The name of the plugin, displayed in Dynatrace.

Can be null.

versionstring

The version of the plugin, displayed in Dynatrace.

Can be null.

typestring

The type of the plugin. It indicates the runtime environment of the plugin (for example, ActiveGate).

The element can hold these values
  • ActiveGate
  • JMX
  • OneAgent
  • PMI

Can be null.

metricGroupstring

The metric group of the plugin. All the metrics, captured by the plugin are children of this group.

Can be null.

propertiesPluginProperty[]

A list of plugin properties.

Can be null.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersionstring

Dynatrace version.

Can be null.

The PluginProperty object

A property of a plugin.

ElementTypeDescription
keystring

The key of the property.

Can be null.

typestring

The type of the property.

Can be null.

defaultValuestring

The default value of the property.

Can be null.

dropdownValuesstring[]

The list of possible values of the property.

If such a list is defined, only values from this list can be assigned to the property.

Can be null.

Response body JSON model

json
{ "id": "custom.remote.python.demo", "name": "ActiveGate demo plugin", "version": "1.01", "type": "ActiveGate", "metricGroup": "custom.demo_metrics", "properties": [ { "key": "serverIp", "type": "STRING", "defaultValue": "127.0.0.1" }, { "key": "password", "type": "PASSWORD", "defaultValue": "" }, { "key": "username", "type": "STRING", "defaultValue": "dynatrace" }, { "key": "dropdownProperty", "type": "DROPDOWN", "defaultValue": "one", "dropdownValues": [ "one", "two", "three" ] } ] }

Example

In this example, the request inquires for parameters of the SAP plugin, which has the ID of custom.remote.python.sap.

The API token is passed in the Authorization header.

Curl

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

Request URL

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

Response body

json
{ "metadata": { "configurationVersions": [ 0 ], "clusterVersion": "1.173.0.20190611-111714" }, "id": "custom.remote.python.sap", "name": "SAP plugin", "type": "ActiveGate", "properties": [ { "key": "password", "type": "PASSWORD", "defaultValue": "" }, { "key": "instance", "type": "STRING", "defaultValue": "" }, { "key": "serverIp", "type": "TEXTAREA", "defaultValue": "" }, { "key": "clientno", "type": "STRING", "defaultValue": "" }, { "key": "username", "type": "STRING", "defaultValue": "" } ] }

Response code

200