Plugins API - POST a plugin ZIP file

  • Reference
  • Published Jun 07, 2019

Uploads a ZIP plugin file to your Dynatrace environment.

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

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins
POSTEnvironment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/plugins

Authentication

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

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

Parameters

Response

Response codes

CodeTypeDescription
201EntityShortRepresentation

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

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
descriptionstring

A short description of the Dynatrace entity.

idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/validator
POSTEnvironment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/plugins/validator

Authentication

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

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

Response

Response codes

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

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

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