Extensions 2.0 API - POST an extension file

Uploads an Extensions 2.0 extension file to your Dynatrace environment.

The request consumes an application/octet-stream payload and produces an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/extensions
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/extensions

Authentication

To execute this request, you need an access token with extensions.write scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
validateOnly
boolean
Validate and store (false) or just validate (true) the uploaded extension file.

If not set, false is used.
query
optional

Request body

Extension 2.0 package file (*.zip) to be uploaded.

Response

Response codes

Code
Type
Description
200

The extension is valid

201

Success. The extension 2.0 has been uploaded.

400

Failed. The input file is invalid.

409

Upload not possible yet, please try again in a few seconds.

4XX

Client side error.

5XX

Server side error.

Response body objects

The ExtensionUploadResponseDto object

Element
Type
Description
assetsInfo

Information about extension assets included

author

Extension author

dataSources
string[]

Data sources that extension uses to gather data

extensionName
string

Extension name

featureSets
string[]

Available feature sets

featureSetsDetails
object

Details of feature sets

fileHash
string

SHA-256 hash of uploaded Extension file

minDynatraceVersion
string

Minimal Dynatrace version that works with the extension

minEECVersion
string

Minimal Extension Execution Controller version that works with the extension

variables
string[]

Custom variables used in extension configuration

version
string

Extension version

The AssetInfo object

Assets types and its count

Element
Type
Description
assetType
string
-
count
integer
-

The AuthorDto object

Extension author

Element
Type
Description
name
string

Author name

The FeatureSetDetails object

Additional information about a Feature Set

Element
Type
Description
metrics

Feature set metrics

The MetricDto object

Metric gathered by an extension

Element
Type
Description
key
string

Metric key

metadata

Metric metadata

The MetricMetadataDto object

Metric metadata

Element
Type
Description
description
string

A short description of the metric

displayName
string

The name of the metric in the user interface

unit
string

The unit of the metric

Response body JSON model

{
  "assetsInfo": [
    {
      "assetType": "string",
      "count": 1
    }
  ],
  "author": {
    "name": "string"
  },
  "dataSources": [
    "string"
  ],
  "extensionName": "string",
  "featureSets": [
    "string"
  ],
  "featureSetsDetails": {},
  "fileHash": "string",
  "minDynatraceVersion": "string",
  "minEECVersion": "string",
  "variables": [
    "string"
  ],
  "version": "1.2.3"
}

Related topics