Skip to content
calternal docs

Set an instance Plugin

PUT
/api/v1/admin/plugins/{id}
curl --request PUT \
  --url https://example.com/api/v1/admin/plugins/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cascade": true, "enabled": true }'

Sets an instance Plugin. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired, 403 if access is denied, 404 if the requested item does not exist and 409 if the request conflicts with the current state. Route: /api/v1/admin/plugins/{id}. Inputs: id. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Stable plugin ID

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
cascade

Disable enabled dependents in the same operation.

boolean
enabled
required

Whether to enable this plugin for the Instance.

boolean
Examplegenerated
{
  "cascade": true,
  "enabled": true
}

Responses

Section titled “Responses”

204

Section titled “204”

Plugin state changed

403

Section titled “403”

Admin role or recent passkey assertion required

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”

Plugin does not exist

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”

Core plugin or enabled dependents prevent the change

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}