Plugins API - GET a plugin's endpoint

Lists properties of the specified endpoint of the ActiveGate plugin.

The request produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/{endpointId}
  • SaaS https://{your-environment-id}{id}/endpoints/{endpointId}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/{endpointId}


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


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 codes

Code Description


Response body

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 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.


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

The API token is passed in the Authorization header.

The endpoint has the following parameters:

Plugin endpoint - expanded


curl -X GET \ \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

Response body

  "id": "5677163660730843402",
  "pluginId": "",
  "name": "SAPacceptance",
  "enabled": true,
  "properties": {
    "clientno": "001",
    "serverIp": "",
    "password": "",
    "instance": "00",
    "username": "DYNATRACE"
  "activeGatePluginModule": {
    "id": "1768386982494938781",
    "name": "GDNDYNSYNVSG03"

Response code