The Schema Management APIs allow administrators to manage JSON schemas that validate principal and resource attributes. All endpoints require BasicAuth authentication.
AddOrUpdateSchema Add or update one or more JSON schemas in the schema store.
HTTP Request POST /admin/schema PUT /admin/schema
Authentication Requires BasicAuth credentials configured in the Cerbos server.
Request Body Array of schema objects to add or update. Minimum 1, maximum 100 schemas. Unique identifier for the schema. Maximum 255 characters. Example: principal.json
JSON schema definition as bytes. Minimum 10 bytes. Example: {"type":"object", "properties":{"department":{"type":"string"}}}
Response Returns an empty response object on success.
Example Request curl -X POST https://cerbos.example.com/admin/schema \ -u admin:password \ -H "Content-Type: application/json" \ -d '{ "schemas": [ { "id": "principal.json", "definition": { "type": "object", "properties": { "department": {"type": "string"}, "role": {"type": "string"}, "level": {"type": "number"} }, "required": ["department"] } } ] }'
ListSchemas List all schema IDs stored in the Cerbos server.
HTTP Request Authentication Requires BasicAuth credentials configured in the Cerbos server.
Response Array of schema ID strings
Example Request curl https://cerbos.example.com/admin/schemas \ -u admin:password
Example Response { "schemaIds" : [ "principal.json" , "resource.album.json" , "resource.photo.json" ] }
GetSchema Retrieve one or more schemas by their IDs.
HTTP Request Authentication Requires BasicAuth credentials configured in the Cerbos server.
Query Parameters One or more schema IDs to retrieve. Minimum 1 ID required. Each ID must be between 1 and 255 characters. Example: principal.json
Response Array of schema objects matching the requested IDs Unique identifier for the schema
Example Request curl "https://cerbos.example.com/admin/schema?id=principal.json" \ -u admin:password
Example Response { "schemas" : [ { "id" : "principal.json" , "definition" : { "type" : "object" , "properties" : { "department" : { "type" : "string" }, "role" : { "type" : "string" }, "level" : { "type" : "number" } }, "required" : [ "department" ] } } ] }
DeleteSchema Permanently delete one or more schemas from the schema store.
HTTP Request Authentication Requires BasicAuth credentials configured in the Cerbos server.
Query Parameters One or more schema IDs to delete. Minimum 1 ID required. Each ID must be between 1 and 255 characters. Example: principal.json
Response Number of schemas successfully deleted
Example Request curl -X DELETE "https://cerbos.example.com/admin/schema?id=principal.json" \ -u admin:password
Example Response