Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cerbos Plan API

Generate query plans for resource filtering.

Cerbos Plan API is one of 13 APIs that Cerbos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Plan. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 0.x.

Requests are made against a single base URL, http://localhost:3592.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.x
Base URL
http://localhost:3592
Authentication
HTTP Basic
Contact
License
Resource Areas
1

Authentication & Security 1

Cerbos Plan API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

  • basicAuth — Basic authentication for the Admin API (default cerbos/cerbosAdmin; override in production).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Plan 1

Generate query plans for resource filtering.

POST
/api/plan/resources
Plan resources
planResources body → 200400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PlanResourcesRequest (6 properties), PlanResourcesResponse (6 properties), Principal (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

PlanResourcesResponse
object
6 properties
Error
object
3 properties
Principal
object
5 properties 2 required
PlanResourcesRequest
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cerbos-plan-api-openapi.yml Raw ↑

Other APIs Cerbos publishes across the network.

Cerbos PDP gRPC API
Cerbos AuthZEN API
Cerbos PDP Admin API
Cerbos Hub API
Cerbos Synapse
Cerbos Admin Audit API
Cerbos Admin Policies API
Cerbos Admin Schemas API
Cerbos Admin Store API
Cerbos AuthZEN API
Cerbos Check API
Cerbos Server API