Extensions 2.0 API - POST an extension file

  • Reference
  • Published Jan 22, 2021

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

ParameterTypeDescriptionInRequired
validateOnlybooleanValidate and store (false) or just validate (true) the uploaded extension file.

If not set, false is used.		queryoptional

Request body

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

Response

Response codes

CodeTypeDescription
200ExtensionUploadResponseDto

The extension is valid

201ExtensionUploadResponseDto

Success. The extension 2.0 has been uploaded.

400ErrorEnvelope

Failed. The input file is invalid.

409ErrorEnvelope

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

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ExtensionUploadResponseDto object

ElementTypeDescription
assetsInfoAssetInfo[]

Information about extension assets included

authorAuthorDto

Extension author

dataSourcesstring[]

Data sources that extension uses to gather data

extensionNamestring

Extension name

featureSetsstring[]

Available feature sets

featureSetsDetailsobject

Details of feature sets

fileHashstring

SHA-256 hash of uploaded Extension file

minDynatraceVersionstring

Minimal Dynatrace version that works with the extension

minEECVersionstring

Minimal Extension Execution Controller version that works with the extension

variablesstring[]

Custom variables used in extension configuration

versionstring

Extension version

The AssetInfo object

Assets types and its count

ElementTypeDescription
assetTypestring-
countinteger-

The AuthorDto object

Extension author

ElementTypeDescription
namestring

Author name

The FeatureSetDetails object

Additional information about a Feature Set

ElementTypeDescription
descriptionstring

Optional description for the feature set

displayNamestring

Optional display name of the feature set

isRecommendedboolean

Marks the feature set as recommended (selected by default during activation)

metricsMetricDto[]

Feature set metrics

The MetricDto object

Metric gathered by an extension

ElementTypeDescription
keystring

Metric key

metadataMetricMetadataDto

Metric metadata

The MetricMetadataDto object

Metric metadata

ElementTypeDescription
descriptionstring

A short description of the metric

displayNamestring

The name of the metric in the user interface

unitstring

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"
}