Extensions API - POST an extension .zip file

Reference
Published Mar 06, 2020

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`
POST	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions`

Authentication

Api-Token:

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

To learn how to obtain and use it, see Personal access tokens.

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	EntityShortRepresentation	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
description	string	A short description of the Dynatrace entity.
id	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity.

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

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`
POST	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/validator`

Authentication

Api-Token:

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

To learn how to obtain and use it, see Personal access tokens.

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

Response body objects

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Develop your own Extensions

Extensions API - POST an extension .zip file

Reference
Published Mar 06, 2020

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`
POST	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions`

Authentication

Api-Token:

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

To learn how to obtain and use it, see Personal access tokens.

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	EntityShortRepresentation	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
description	string	A short description of the Dynatrace entity.
id	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity.

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

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`
POST	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/extensions/validator`

Authentication

Api-Token:

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

To learn how to obtain and use it, see Personal access tokens.

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

Response body objects

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Develop your own Extensions

Extensions API - POST an extension .zip file

Authentication

Api-Token:

Parameters

Response

Response codes

Response body objects

The EntityShortRepresentation object

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Validate payload

Authentication

Api-Token:

Response

Response codes

Response body objects

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Related topics

Extensions API - POST an extension .zip file

Authentication

Api-Token:

Parameters

Response

Response codes

Response body objects

The EntityShortRepresentation object

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Validate payload

Authentication

Api-Token:

Response

Response codes

Response body objects

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Related topics

The `EntityShortRepresentation` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object

The `EntityShortRepresentation` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object