Plugins API - POST a new endpoint of a plugin

Creates a new endpoint for the specified ActiveGate plugin.

The request consumes and produces an application/json payload.

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

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

The ActiveGate plugin module that hosts the endpoint.

required

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description Required
id string

The ID of the Dynatrace entity.

required
name string

The name of the Dynatrace entity.

optional
description string

A short description of the Dynatrace entity.

optional

Response format

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.

This request is in beta and may be changed in non compatible way.

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

Parameters

Parameter Type Description In Required
id string

The ID of the required plugin.

path required
body RemotePluginEndpoint

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

body optional

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

The ActiveGate plugin module that hosts the endpoint.

required

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description Required
id string

The ID of the Dynatrace entity.

required
name string

The name of the Dynatrace entity.

optional
description string

A short description of the Dynatrace entity.

optional

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

api-examples/config/plugin/post-plugin-endpoint.json
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