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

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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

Authentication

To execute this request, you need an access token with Write configuration (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

ElementTypeDescription
extensionIdstring

The ID of the extension.

Can be null.

enabledboolean

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

useGlobalboolean

Allows to skip current configuration and use global one.

propertiesobject

The list of extension parameters.

Each parameter is a key-value pair.

Can be null.

hostIdstring

The ID of the host on which the extension runs.

Can be null.

activeGateEntityShortRepresentation

The short representation of a Dynatrace entity.

Can be null.

endpointIdstring

The ID of the endpoint.

Can be null.

endpointNamestring

The name of the endpoint, displayed in Dynatrace.

Can be null.

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.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

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.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

POSTManaged https://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/{id}/instances/validator
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances/validator
Environment ActiveGate https://{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 Write configuration (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.