Extensions API - POST an extension .zip file
Uploads a .zip extension file to your Dynatrace environment.
The request consumes a multipart/form-data
payload and produces an application/json
payload.
POST | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/extensions |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions |
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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
file | .zip file | Extension .zip file to be uploaded. The file name must match the name field in the plugin.json file.For example, for the extension whose name is custom.remote.python.demo , the name of the extension file must be custom.remote.python.demo.zip . | body | required |
overrideAlerts | Boolean | Use extension-defined thresholds for alerts (true ) or user-defined thresholds (false ).Extension-defined thresholds are stored in the plugin.json file.If not set, user-defined thresholds are used. | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
201 | Entity | Success. Extension has been uploaded. Response contains the ID of the extension. |
400 | ErrorEnvelope | Failed. The input is invalid |
Response body objects
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
description | string | A short description of the Dynatrace entity. |
Response body JSON model
{
"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.
POST | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/extensions/validator |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/extensions/validator | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/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
Code | Type | Description |
---|---|---|
204 | Validated. The submitted extension is valid. Response doesn't have a body. | |
400 | ErrorEnvelope | Failed. The input is invalid |