Skip to content

Plugin

Routes registered by plugins, and plugin info. · 5 endpoints

Plugin-provided route (GET)

GET/api/v1/plugins/{pluginId}/{path}Any API key

Runs a route from contributes.routes of an enabled plugin. The scope required is the one declared by the route; body max 1 MB. The response is the body returned by the plugin.

Parameters

pluginId
path · required
string
max 100
path
path · required
string
max 1000 · default ""

Example request

bash
curl "http://127.0.0.1:9900/api/v1/plugins/{pluginId}/{path}" \
  -H "Authorization: Bearer dpk_xxx"

Plugin-provided route (POST)

POST/api/v1/plugins/{pluginId}/{path}Any API key

Runs a route from contributes.routes of an enabled plugin. The scope required is the one declared by the route; body max 1 MB. The response is the body returned by the plugin.

Parameters

pluginId
path · required
string
max 100
path
path · required
string
max 1000 · default ""

Example request

bash
curl -X POST "http://127.0.0.1:9900/api/v1/plugins/{pluginId}/{path}" \
  -H "Authorization: Bearer dpk_xxx"

Plugin-provided route (PUT)

PUT/api/v1/plugins/{pluginId}/{path}Any API key

Runs a route from contributes.routes of an enabled plugin. The scope required is the one declared by the route; body max 1 MB. The response is the body returned by the plugin.

Parameters

pluginId
path · required
string
max 100
path
path · required
string
max 1000 · default ""

Example request

bash
curl -X PUT "http://127.0.0.1:9900/api/v1/plugins/{pluginId}/{path}" \
  -H "Authorization: Bearer dpk_xxx"

Plugin-provided route (PATCH)

PATCH/api/v1/plugins/{pluginId}/{path}Any API key

Runs a route from contributes.routes of an enabled plugin. The scope required is the one declared by the route; body max 1 MB. The response is the body returned by the plugin.

Parameters

pluginId
path · required
string
max 100
path
path · required
string
max 1000 · default ""

Example request

bash
curl -X PATCH "http://127.0.0.1:9900/api/v1/plugins/{pluginId}/{path}" \
  -H "Authorization: Bearer dpk_xxx"

Plugin-provided route (DELETE)

DELETE/api/v1/plugins/{pluginId}/{path}Any API key

Runs a route from contributes.routes of an enabled plugin. The scope required is the one declared by the route; body max 1 MB. The response is the body returned by the plugin.

Parameters

pluginId
path · required
string
max 100
path
path · required
string
max 1000 · default ""

Example request

bash
curl -X DELETE "http://127.0.0.1:9900/api/v1/plugins/{pluginId}/{path}" \
  -H "Authorization: Bearer dpk_xxx"