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.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances |
Environment ActiveGate | https://{your-activegate-domain}:9999/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
The ID of the extension
The JSON body of the request. Contains new configuration of the extension.
Request body objects
The ExtensionConfigurationDto
object
The extension is enabled (true
) or disabled (false
).
The ID of the endpoint.
The name of the endpoint, displayed in Dynatrace.
The ID of the extension.
The ID of the host on which the extension runs.
The list of extension parameters.
Each parameter is a key-value pair.
Allows to skip current configuration and use global one.
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
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.
{"activeGate": {"id": "7835970235169136995","name": "ActiveGate Host Name"},"enabled": true,"hostId": "HOST-01A7DEFA5340A86D","id": "custom.remote.python.demo","properties": {"dropdownProperty": "three","password": "","serverIp": "127.0.0.1","username": "dynatrace"},"useGlobal": false}
Response
Response codes
Success. The extension configuration has been created. Response contains the ID of the new configuration.
Response body objects
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
Response body JSON model
{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}
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.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/{id}/instances/validator |
Environment ActiveGate | https://{your-activegate-domain}:9999/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
Validated. The submitted configuration is valid. Response doesn't have a body.