API Reference
Generated REST and gRPC contracts for Open Spanner.
REST
The complete generated REST contract is committed in these formats:
openapi/openapi.jsonopenapi/swagger.jsonopenapi/swagger.yaml
It covers dashboard authentication, shared workspaces, API keys, meters, subjects, usage, plans, entitlement consumption and decisions, alerts, exports, reconciliation, retention, and system operations. The generated files are the source of truth for paths, request bodies, responses, and status codes; product guides intentionally avoid duplicating that full endpoint inventory.
The narrower backend SDK contract is openapi/sdk-openapi.json. It contains
runtime metering and entitlement operations without control-plane and operator
endpoints. See SDKs for packages and examples.
The running service does not host Swagger UI. Use the checked-in specification with the OpenAPI viewer or client generator of your choice.
gRPC
Open Spanner exposes CreateUsage, CreateUsageBulk, and StreamUsage on
OPEN_SPANNER_GRPC_ADDR. Authenticate with API-key request metadata using
authorization: Bearer <key>, x-open-spanner-api-key, or x-api-key.
The protobuf source is proto/open_spanner/v1/usage.proto. Use gRPC for
continuous trusted-backend ingestion; use REST for product configuration,
queries, entitlement decisions, and control-plane operations.