List available Plugins

GET

/api/v1/plugins

const url = 'https://example.com/api/v1/plugins';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/plugins

Lists the available Plugins. It requires a signed-in User with the data scope. It can return 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/plugins. Inputs: . Safe reads can use bounded retries.

Responses

200

Plugin manifests, enablement and UI entry points

application/json

The plugin catalog returned to the SPA, including disabled plugins.

object

plugins

required

Plugin descriptors in stable ID order.

Array<object>

A plugin manifest with the current enablement state and client data.

object

enabled

required

Whether an administrator enabled this plugin for the Instance.

boolean

manifest

required

The plugin’s public manifest.

object

core

required

True when this plugin is required by the instance and cannot be disabled.

boolean

default_enabled

required

Enable the plugin for a new instance unless an administrator changes it.

boolean

description

required

Short description.

string

required

Stable lowercase identifier used in API paths.

string

kind

required

Plugin origin.

string

Allowed values: core community

name

required

Human-readable plugin name.

string

required_scopes

required

Scopes a client needs to call this plugin’s routes.

Array<string>

requires

required

Other plugins that must be enabled before this plugin can run.

Array<string>

user_toggle_allowed

required

Allow each user to hide this plugin when it is enabled for the instance.

boolean

version

required

Plugin version.

string

required

UI entry points available to the current user.

object

actions

required

Command-palette actions.

Array<object>

A command-palette action contributed by a plugin.

object

description

Optional short explanation.

string | null

required

Stable action identifier within the plugin.

string

shortcut

Optional keyboard shortcut shown by the client.

string | null

title

required

Action label.

string

routes

required

SPA routes.

Array<object>

A client route contributed by a plugin.

object

required

Stable route identifier within the plugin.

string

path

required

SPA route pattern.

string

title

required

Human-readable route title.

string

sidebar

required

Sidebar entries.

Array<object>

A sidebar entry contributed by a plugin.

object

href

required

Client route opened by this entry.

string

icon

Optional icon name understood by the client.

string | null

required

Stable entry identifier within the plugin.

string

title

required

Text shown in the sidebar.

string

user_enabled

This User’s mode state, or None when no user toggle applies.

boolean | null

Example

{
  "plugins": [
    {
      "manifest": {
        "kind": "core"
      }
    }
  ]
}