Get all plugins

GET 
/api/v1/plugins

Retrieve a list of all plugins, excluding drafts

Request

Query Parameters

includeDrafts boolean
pageSize int32required

Default value: 250

Number of results to return per page, between 1 and 1000. Default 250.

page int32required

Default value: 0

Page number to return, 0-indexed. Default 0.

Responses

200

List of plugins

application/json

Schema

Schema

page int32required

Current page number, 0-indexed

plugins

object[]

required

Array [

contexts

object[]

required

Which contexts the plugin should execute/show up in, e.g. { "type": "GLOBAL" }

Array [

type stringrequired

]

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

The minimum role required to view the plugin, e.g. VIEWER, USER, MANAGER, OWNER, or the tag for a custom role. Learn more about each permission in our docs.

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

]

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "page": 0,
  "plugins": [
    {
      "contexts": [
        {
          "type": "string"
        }
      ],
      "createdBy": {
        "dateCreated": "2024-07-29T15:51:28.071Z",
        "email": "string",
        "id": 0,
        "name": "string",
        "oauthUserId": "string",
        "tenantId": 0
      },
      "description": "string",
      "isDraft": true,
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "minimumRoleRequired": "string",
      "name": "string",
      "proxyTag": "string",
      "tag": "string"
    }
  ],
  "total": 0,
  "totalPages": 0
}

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...