Change a plugin's properties, such as name, description, code, group membership, etc.

  • Published on Jul 22, 2025
  • 2 minute(s) read
Prev Next
Patch
/sys/v1/plugins/{plugin_id}

Change a plugin's properties, such as name, description, code, group membership, etc.

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Path parameters
plugin_id
string (uuid) Required
Body parameters
object
default_group
string (uuid) | null

The default group a plugin belongs to.

description
string | null

Description of the plugin.

enabled
boolean | null

Is plugin enabled.

name
string | null

Name of the plugin, which must be unique within an account.

Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
plugin_type
string

Type of a plugin.

Valid values[ "STANDARD", "IMPERSONATING", "CUSTOMALGORITHM" ]
signature
string | null

A detached OpenPGP signature over the plugin source code.

The signature packet must be armored. If the account has a plugin code signing policy, the signature is required in the following cases:

  • when creating a new plugin
  • when updating the plugin code
source
OneOf
object
object
repo_url
string Required
plugin_name
string Required
version
string Required
Pattern^\d+.\d+$
object
object
language
string Required

Language of plugin code.

Valid values[ "LUA" ]
code
string Required
add_groups
Array of string | null

Set of all the groups that plugin is part of.

string (uuid)
del_groups
Array of string | null

Set of all the groups that plugin is part of.

string (uuid)
mod_groups
Array of string | null

Set of all the groups that plugin is part of.

string (uuid)
Responses
2XX

Success result

object
acct_id
string (uuid)

The id of the Account that the plugin belongs to.

created_at
string

Timestamp when the plugin was created.

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
creator

A security principal.

OneOf
PrincipalVariantApp
object (PrincipalVariantApp)
app
string (uuid)
PrincipalVariantUser
object (PrincipalVariantUser)
user
string (uuid)
PrincipalVariantPlugin
object (PrincipalVariantPlugin)
plugin
string (uuid)
PrincipalVariantUserViaApp
object (PrincipalVariantUserViaApp)
userviaapp
object
user_id
string (uuid)
scopes
Array of string (OauthScope)
string

OAuth scope.

Valid values[ "app", "openid", "email", "profile" ]
string
string
Valid values[ "system" ]
string
string
Valid values[ "unregistereduser" ]
default_group
string (uuid)

The default group a plugin belongs to.

description
string | null

Description of the plugin.

enabled
boolean

Is plugin enabled.

lastrun_at
string

Timestamp when the plugin was most recently used.

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
lastupdated_at
string

Timestamp when the plugin was most recently updated.

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
legacy_access
boolean

If a requester is updating/using a Plugin they must have the relevant permissions in all Groups that Plugin has access to. But for legacy Plugins, the requester is required to have relevant permissions in any one of the groups that Plugin has access to.

name
string

Name of the plugin, which must be unique within an account.

Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
plugin_id
string (uuid)

Unique id to identify a plugin.

plugin_type
string

Type of a plugin.

Valid values[ "STANDARD", "IMPERSONATING", "CUSTOMALGORITHM" ]
source

Plugin code that will be executed inside SGX enclave.

OneOf
object
object
repo_url
string
name
string
version
string
Pattern^\d+.\d+$
language
string

Language of plugin code.

Valid values[ "LUA" ]
code
string
object
object
language
string

Language of plugin code.

Valid values[ "LUA" ]
code
string
groups
Array of string

Set of all the groups that plugin is part of.

string (uuid)