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.

Early Adopter

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

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

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 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 Description
201

Success. Extension has been uploaded. Response contains the ID of the extension.

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.

Early Adopter

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

POST
  • Managed 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

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 extension is valid. Response doesn't have a body.

400

Failed. The input is invalid

Response body

A successful request doesn't return any content.