Get all plugins

GET 
/api/v1/plugins

Retrieve a list of all plugins, excluding drafts

Request

Query Parameters

includeDrafts boolean

Responses

200

List of plugins

application/json

Schema

Schema

plugins object[]required
Array [
contexts object[]required
Which contexts the plugin should execute/show up in, e.g. { "type": "GLOBAL" }
Array [
]
createdBy object
The creator of the plugin. Null if created via API.
dateCreated date-timerequired
email stringrequired
id int64
name stringrequired
oauthUserId stringrequired
tenantId int64required
description string
Description of the plugin
isDraft booleanrequired
Whether the plugin is generally available or not
lastUpdated date-timerequired
When the plugin was last updated
minimumRoleRequired stringrequired
Possible values: [VIEWER, USER, MANAGER, API, OWNER]
The minimum role required to see the plugin, e.g. USER
name stringrequired
Display name of the plugin
proxyTag string
The identifier of the proxy to use for requests from this plugin
tag stringrequired
Unique identifier for the plugin
]

Example (from schema)

{
  "plugins": [
    {
      "contexts": [
        {
          "type": "string"
        }
      ],
      "createdBy": {
        "dateCreated": "2023-12-01T16:26:14.236Z",
        "email": "string",
        "id": 0,
        "name": "string",
        "oauthUserId": "string",
        "tenantId": 0
      },
      "description": "string",
      "isDraft": true,
      "lastUpdated": "2023-12-01T16:26:14.237Z",
      "minimumRoleRequired": "VIEWER",
      "name": "string",
      "proxyTag": "string",
      "tag": "string"
    }
  ]
}

Loading...