Plugins API - POST a plugin ZIP file

Uploads a ZIP plugin file to your Dynatrace environment.

The request consumes a multipart/form-data payload and produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required

file

ZIP file

Plugin ZIP file to be uploaded.

The file name must match the name field in the plugin.json file.

For example, for the plugin whose name is custom.remote.python.demo, the name of the plugin file must be custom.remote.python.demo.zip.

body

required

overrideAlerts

Boolean

Use plugin-defined thresholds for alerts (true) or user-defined thresholds (false).

Plugin-defined thresholds are stored in the plugin.json file.

If not set, user-defined thresholds are used.

query

optional

Response

Response codes

Code Description
201

Success. Plugin has been uploaded. Response contains the ID of the plugin.

400

Failed. The input is invalid.

Response body

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.

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
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/validator
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.

Example

In this example the request uploads the custom.remote.python.simple_math.zip file, which is stored in the C:\temp\ directory, to the mySampleEnv environment.

The API token is passed in the Authorization header.

The response code of 201 confirms a successful upload. The ID of the plugin is returned.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/ \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \  
  -H 'content-type: multipart/form-data' \
  -F 'file=@C:\temp\custom.remote.python.simple_math.zip'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/

Response body

{
  "id": "custom.remote.python.simple_math"
}

Response code

201