• Home
  • Dynatrace API
  • Configuration
  • Plugins
  • POST a new plugin's endpoint

Plugins API - POST a new plugin's endpoint

Creates a new endpoint for the specified ActiveGate plugin.

The request consumes and produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/endpoints
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints

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

ParameterTypeDescriptionInRequired
idstring

The ID of the plugin where you want to create an endpoint.

pathrequired
bodyRemotePluginEndpoint

The JSON body of the request. Contains parameters of the new plugin endpoint.

bodyoptional

Request body objects

The RemotePluginEndpoint object

Configuration of a plugin endpoint.

ElementTypeDescriptionRequired
idstring

The ID of the endpoint.

optional
pluginIdstring

The ID of the plugin to which the endpoint belongs.

optional
namestring

The name of the endpoint, displayed in Dynatrace.

optional
enabledboolean

The endpoint is enabled (true) or disabled (false).

optional
propertiesobject

The list of endpoint parameters.

Each parameter is a property-value pair.

optional
activeGatePluginModuleEntityShortRepresentation

The short representation of a Dynatrace entity.

required

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescriptionRequired
idstring

The ID of the Dynatrace entity.

required
namestring

The name of the Dynatrace entity.

optional
descriptionstring

A short description of the Dynatrace entity.

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "id": "-2183662974968812535", "pluginId": "custom.remote.python.demo", "name": "Demo endpoint", "enabled": true, "properties": { "serverIp": "127.0.0.1", "password": "", "username": "dynatrace", "dropdownProperty": "two" }, "activeGatePluginModule": { "id": "-8844900174269363000" } }

Response

Response codes

CodeTypeDescription
201EntityShortRepresentation

Success. The plugin endpoint has been created. Response contains the ID of the new endpoint.

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

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

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.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/endpoints/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/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 configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Example

In this example, the request creates a new endpoint for the SAP plugin which has the ID of custom.remote.python.sap.

The API token is passed in the Authorization header.

Curl

bash
curl -X POST \ https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.sap/endpoints \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ -H 'Content-Type: application/json' \ -d '{ "pluginId": "custom.remote.python.sap", "name": "RESTtest", "enabled": false, "properties": { "clientno": "001", "serverIp": "127.0.0.1", "password": "", "instance": "00", "username": "DT" }, "activeGatePluginModule": { "id": "1768386982494938781" } }'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.sap/endpoints

Request body

json
{ "pluginId": "custom.remote.python.sap", "name": "RESTtest", "enabled": false, "properties": { "clientno": "001", "serverIp": "192.168.0.1", "password": "", "instance": "00", "username": "DT" }, "activeGatePluginModule": { "id": "1768386982494938781" } }

Response body

json
{ "id": "8757307336635955682" }

Response code

201

Result

The new endpoint looks like this in the UI:

Plugin endpoint - new