Skip to content

Get platform plugin configuration schema.

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

Returns a plugin configuration JSON Schema from KV together with plugin version and metadata. Missing plugin or schema records return not found.

id
required
string

Plugin schema response.

Media type application/json
object
pluginId
required
string
version
required
string
schema
required
object
key
additional properties
meta
required
object
key
additional properties
key
additional properties
Example generated
{
"pluginId": "example",
"version": "example",
"schema": {
"additionalProperty": "example"
},
"meta": {
"additionalProperty": "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"
}

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