Skip to content

List tenant plugins.

GET
/api/admin/plugins
Code sample: Shell / cURL
curl --request GET \
--url https://auth.example.com/api/admin/plugins \
--header 'Authorization: Bearer <token>'

List plugin registry entries visible in the current tenant, including built-in plugins lazily registered at request time.

Plugin list response.

Media type application/json
object
plugins
required
Array<object>
object
id
string
name
string
version
string
enabled
boolean
configured
boolean
configSource
string | null
missingRequiredFields
Array<string>
provisioning
object
operationId
required
string
state
required
string
Allowed values: pending blocked
key
additional properties
backendKind

Present for operator-approved custom Dynamic Worker plugins.

string
Allowed values: dynamic_worker
capabilityManifestDigest
string
/^[a-f0-9]{64}$/
activeVersionDigest

Digest of the immutable code and policy version selected for new rollouts.

string
/^[a-f0-9]{64}$/
credentialSlots
Array<object>
<= 16 items
object
configKey
required
string
required
required
boolean
key
additional properties
resources

Tenant-scoped resource requirements declared by an operator-approved Dynamic Worker plugin. Authrim-managed provisioning is the default; allowExisting controls whether an existing Cloudflare resource may be selected during enablement.

Array<object>
<= 16 items
object
logicalResourceId
required
string
binding
required
string
kind
required
string
Allowed values: d1 kv_namespace r2_bucket
access
required
string
Allowed values: read_only read_write
allowExisting
required
boolean
key
additional properties
key
additional properties
total
required
integer
key
additional properties
Example
{
"plugins": [
{
"id": "email.smtp",
"name": "SMTP Email Provider",
"version": "1.0.0",
"enabled": true,
"configured": true,
"configSource": "kv",
"missingRequiredFields": []
}
]
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}