Plugins API - GET a plugin

Lists the properties of the specified plugin.

The request produces an application/json payload.

GET
  • Managed 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}

Parameters

Parameter Type Description In Required
id string

The ID of the required plugin.

path required

Response format

The Plugin object

General configuration of a plugin.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

id string

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

name string

The name of the plugin, displayed in Dynatrace.

version string

The version of the plugin, displayed in Dynatrace.

type string

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

properties PluginProperty[]

A list of plugin properties.

The PluginProperty object

A property of a plugin.

Element Type Description
key string

The key of the property.

type string

The type of the property.

defaultValue string

The default value of the property.

dropdownValues string[]

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.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.

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

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

Request URL

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

Response body

{
  "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