Gets web plugins

GET /api/2.0/settings/webplugins

Request

Gets web plugins

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Query

enabledboolean

Enabled

Examples

GET /api/2.0/settings/webplugins?enabled=true HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url 'https://example.com/api/2.0/settings/webplugins?enabled=true' \
  --header 'Accept: application/json'

Responses

200

Web plugin

namestring

Name

versionstring

Version

descriptionstring

Description

licensestring

License

authorstring

Author

homePagestring

Home page

pluginNamestring

PluginName

scopesstring

Scopes

imagestring

Image

createByobject
idstringformat: uuid

ID

displayNamestring

Display name

titlestring

Title

avatarstring

Avatar

avatarOriginalstring

Original size avatar

avatarMaxstring

Maximum size avatar

avatarMediumstring

Medium size avatar

avatarSmallstring

Small avatar

profileUrlstring

Profile URL

hasAvatarboolean

Specifies if the user has an avatar or not

isAnonimboolean

Specifies if the user is an anonim or not

createOnstringformat: date-time

Create on

enabledboolean

Enabled

systemboolean

System

urlstring

Url

settingsstring

Settings

401

Unauthorized

403

Plugins disabled

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).