Plugins API - GET a plugin's endpoint

Lists properties of the specified endpoint of the ActiveGate plugin.

The request produces an application/json payload.

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}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/{endpointId}`

Authentication

To execute this request, you need Read configuration (ReadConfig) 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 required plugin.	path	optional
endpointId	string	The ID of the required endpoint.	path	optional

Response

Response codes

Code	Type	Description
200	RemotePluginEndpoint	Success

Response body objects

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 short representation of a Dynatrace entity.	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 body JSON model

json
{
  "id": "-2183662974968812535",
  "pluginId": "custom.remote.python.demo",
  "name": "Demo endpoint",
  "enabled": true,
  "properties": {
    "serverIp": "127.0.0.1",
    "password": "",
    "username": "dynatrace",
    "dropdownProperty": "two"
  },
  "activeGatePluginModule": {
    "id": "-8844900174269363000"
  }
}

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

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

Request URL

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

Response body

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