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.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/endpoints
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

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

path required
body RemotePluginEndpoint

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

body optional

Body format

The RemotePluginEndpoint object

Configuration of a plugin endpoint.

Element Type Description Required
id string

The ID of the endpoint.

optional
pluginId string

The ID of the plugin to which the endpoint belongs.

optional
name string

The name of the endpoint, displayed in Dynatrace.

optional
enabled boolean

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

optional
properties object

The list of endpoint parameters.

Each parameter is a property-value pair.

optional
activeGatePluginModule EntityShortRepresentation required

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description Required
id string

The ID of the Dynatrace entity.

required

Response

Response codes

Code Description
201

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

400

Failed. The input is invalid.

Response body

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

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
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/endpoints/validator
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.

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

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.sap/endpoints \
  -H 'Authorization: Api-token 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

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

Request body

Download
{
  "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

{
  "id": "8757307336635955682"
}

Response code

201

Result

The new endpoint looks like this in the UI:

Plugin endpoint - new