Skip to content
Authrim

List platform plugins.

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

Lists registered plugins in platform scope. Built-in plugins are lazily registered, enabled/configuration state is resolved from KV, and the list is sorted by plugin name or id.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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
externalExecutionAllowed

Only on Dynamic Worker plugins, for a tenant request: whether the tenant’s plugin.enabled setting lets external plugin code run. When false, the plugin cannot be enabled and none of its code runs.

boolean
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": []
    }
  ]
}

401

Section titled “401 ”

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"
}

403

Section titled “403 ”

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"
}

500

Section titled “500 ”

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"
}