• Home
  • Dynatrace API
  • Configuration
  • Extensions
  • POST a new instance of an extension

Extensions API - POST a new extension's instance

Creates a new instance for the specified extension.

The request consumes and produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/instances
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/instances

Authentication

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

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

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the extension

pathrequired
bodyExtensionConfigurationDto

The JSON body of the request. Contains new configuration of the extension.

bodyoptional

Request body objects

The ExtensionConfigurationDto object

ElementTypeDescriptionRequired
extensionIdstring

The ID of the extension.

optional
enabledboolean

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

required
useGlobalboolean

Allows to skip current configuration and use global one.

required
propertiesobject

The list of extension parameters.

Each parameter is a key-value pair.

optional
hostIdstring

The ID of the host on which the extension runs.

optional
activeGateEntityShortRepresentation

The short representation of a Dynatrace entity.

optional
endpointIdstring

The ID of the endpoint.

optional
endpointNamestring

The name of the endpoint, displayed in Dynatrace.

optional

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescriptionRequired
idstring

The ID of the Dynatrace entity.

required
namestring

The name of the Dynatrace entity.

optional
descriptionstring

A short description of the Dynatrace entity.

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "id": "custom.remote.python.demo", "enabled": true, "useGlobal": false, "hostId": "HOST-01A7DEFA5340A86D", "properties": { "serverIp": "127.0.0.1", "username": "dynatrace", "password": "", "dropdownProperty": "three" }, "activeGate": { "id": "7835970235169136995", "name": "ActiveGate Host Name" } }

Response

Response codes

CodeTypeDescription
201EntityShortRepresentation

Success. The extension configuration has been created. Response contains the ID of the new configuration.

400ErrorEnvelope

Failed. The input is invalid

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

json
{ "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity", "description": "Dynatrace entity for the REST API example" }

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/instances/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/instances/validator

Authentication

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

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

Response

Response codes

CodeTypeDescription
204

Validated. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid

Related topics
  • Extensions

    Learn about the extensions framework offered by Dynatrace.