Plugins API - GET an endpoint of a plugin

Lists properties of the specified endpoint of the ActiveGate plugin.

The request produces an application/json payload.

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

GET
  • 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 required plugin.

path required
endpointId string

The ID of the required endpoint.

path required

Response format

The RemotePluginEndpoint object

Configuration of a plugin endpoint.

Element Type Description
id string

The ID of the endpoint.

pluginId string

The ID of the plugin to which the endpoint belongs.

name string

The name of the endpoint, displayed in Dynatrace.

enabled boolean

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

properties object

The list of endpoint parameters.

Each parameter is a property-value pair.

activeGatePluginModule EntityShortRepresentation

The ActiveGate plugin module that hosts the endpoint.

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.

Example

In this example, the request inquires for the parameter of the SAPacceptance endpoint, which has the ID of 5677163660730843402. The endpoint belongs to the SAP plugin that has the ID of custom.remote.python.sap.

The API token is passed in the Authorization header.

The endpoint has the following parameters:

Plugin endpoint - expanded

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.sap/endpoints/5677163660730843402 \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

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

Response body

{
  "id": "5677163660730843402",
  "pluginId": "custom.remote.python.sap",
  "name": "SAPacceptance",
  "enabled": true,
  "properties": {
    "clientno": "001",
    "serverIp": "192.168.1.0",
    "password": "",
    "instance": "00",
    "username": "DYNATRACE"
  },
  "activeGatePluginModule": {
    "id": "1768386982494938781",
    "name": "GDNDYNSYNVSG03"
  }
}

Response code

200