Extensions API - GET global configuration

  • Reference
  • Published Mar 06, 2020

Gets the global configuration of the specified OneAgent or JMX extension.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/global
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/extensions/{id}/global

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 extension to be updated.

pathrequired

Response

Response codes

CodeTypeDescription
200GlobalExtensionConfiguration

Global configuration of given extension.

Response body objects

The GlobalExtensionConfiguration object

Global Configuration of OneAgent and JMX extension

ElementTypeDescription
enabledboolean

The extension is enabled (true) or disabled (false).

extensionIdstring

The ID of the extension.

infraOnlyEnabledboolean

The plugin is enabled (true) or disabled (false) globally for hosts in infrastructure-only monitoring mode

propertiesobject

The list of configuration parameters.

Each parameter is a key-value pair.

Response body JSON model

{
  "id": "custom.remote.python.demo",
  "properties": [
    {
      "defaultValue": "127.0.0.1",
      "key": "serverIp",
      "type": "STRING"
    },
    {
      "defaultValue": "",
      "key": "password",
      "type": "PASSWORD"
    },
    {
      "defaultValue": "dynatrace",
      "key": "username",
      "type": "STRING"
    },
    {
      "defaultValue": "one",
      "dropdownValues": [
        "one",
        "two",
        "three"
      ],
      "key": "dropdownProperty",
      "type": "DROPDOWN"
    }
  ]
}