Plugins API - GET all plugin's endpoints
Lists all endpoints of the specified plugin.
The request produces an application/json payload.
| GET |
|
Authentication
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 Authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string |
The ID of the required plugin. |
path | required |
Response format
The StubList object
An ordered list of short representations of Dynatrace entities.
| Element | Type | Description |
|---|---|---|
| values | EntityShortRepresentation[] | An ordered list of short representations of Dynatrace entities. |
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. |
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1",
"description": "Dynatrace entity 1 for the REST API example\n"
},
{
"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:
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.sap/endpoints \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/plugins/custom.remote.python.sap/endpoints
Response body
{
"values": [
{
"id": "5677163660730843402",
"name": "SAPacceptance"
},
{
"id": "3369768960632214848",
"name": "SAPdevel"
}
]
}
Response code
200