Plugins API - PUT an endpoint of a plugin

Updates properties of the specified endpoint of the ActiveGate plugin.

The request consumes an application/json payload.

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

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/{endpointId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/endpoints/{endpointId}

Parameters

Parameter Type Description In Required
id string

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

If you set the plugin ID in the body as well, it must match this ID.

path required
endpointId string

The ID of the endpoint to be updated.

If you set the endpoint ID in the body as well, it must match this ID.

path required
body RemotePluginEndpoint

The JSON body of the request. Contains updated parameters of the 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

A successful request doesn't return any content.

Example

In this example, the request updates the RESTtest endpoint of the SAP plugin which has the ID of custom.remote.python.sap. It makes the following changes to the endpoint:

  • name to RESTtest - updated
  • serverIp to 192.168.1.1
  • activeGatePluginModule to l-009 which has the ID of 6121289130553435111

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own.

The original endpoint has the following parameters:

Plugin endpoint - new

Curl

curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.sap/endpoints/8757307336635955682 \
  -H 'Authorization: Api-token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \  
  -d '{
    "name": "RESTtest - updated",
    "enabled": false,
    "properties": {
        "clientno": "001",
        "serverIp": "192.168.1.1",
        "password": "",
        "instance": "00",
        "username": "DT"
    },
    "activeGatePluginModule": {
        "id": "6121289130553435111"
    }
}'

Request URL

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

Request body

api-examples/config/plugin/put-plugin-endpoint.json
Download
{
  "name": "RESTtest - updated",
  "enabled": false,
  "properties": {
    "clientno": "001",
    "serverIp": "192.168.1.1",
    "password": "",
    "instance": "00",
    "username": "DT"
  },
  "activeGatePluginModule": {
    "id": "6121289130553435111"
  }
}

Response code

204

Result

The updated endpoint looks like this in the UI:

Plugin endpoint - updated