• Home
  • Dynatrace API
  • Configuration
  • Plugins
  • GET all plugin's endpoints

Plugins API - GET all plugin's endpoints

Lists all endpoints of the specified plugin.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/plugins/{id}/endpoints
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required plugin.

pathrequired

Response

Response codes

CodeTypeDescription
200StubList

Success

Response body objects

The StubList object

An ordered list of short representations of Dynatrace entities.

ElementTypeDescription
valuesEntityShortRepresentation[]

An ordered list of short representations of Dynatrace entities.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

json
{ "values": [ { "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity 1", "description": "Dynatrace entity 1 for the REST API example" }, { "id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618", "name": "Dynatrace entity 2" }, { "id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f" } ] }

Example

In this example, the request inquires for endpoints of the SAP plugin, which has the ID of custom.remote.python.sap.

The API token is passed in the Authorization header.

The request lists these endpoints:

Plugin endpoints

Curl

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

Request URL

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

Response body

json
{ "values": [ { "id": "5677163660730843402", "name": "SAPacceptance" }, { "id": "3369768960632214848", "name": "SAPdevel" } ] }

Response code

200