Plugins API - GET all plugins
Lists all plugins uploaded to your DESK environment.
The request produces an application/json payload.
| GET |
|
Parameters
The request doesn't provide any configurable parameters.
Response format
The StubList object
An ordered list of short representations of DESK entities.
| Element | Type | Description |
|---|---|---|
| values | EntityShortRepresentation[] | An ordered list of short representations of DESK entities. |
The EntityShortRepresentation object
The short representation of a DESK entity.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the DESK entity. |
| name | string | The name of the DESK entity. |
| description | string | A short description of the DESK entity. |
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "DESK entity 1",
"description": "DESK entity 1 for the REST API example\n"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "DESK entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Example
In this example, the request lists all the plugins uploaded to the mySampleEnv environment.
The API token is passed in the Authorization header.
The result is truncated to four entries. The request lists these plugins:
Curl
curl -X GET \
https://mySampleEnv.live.dexp.ae/api/config/v1/plugins \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dexp.ae/api/config/v1/plugins
Response body
{
"values": [
{
"id": "custom.remote.python.sap",
"name": "SAP plugin",
"description": "ActiveGate plugin"
},
{
"id": "custom.remote.python.simple_math",
"name": "MathPlugin",
"description": "ActiveGate plugin"
},
{
"id": "custom.python.wavebuoyplugin",
"name": "WaveBuoy Plugin",
"description": "OneAgent plugin"
},
{
"id": "custom.jmx.creatorCreatedPlugin1506519805362",
"name": "Jetty2",
"description": "JMX plugin"
}
]
}
Response code
200