Skip to main content

Management API

The Management API is the public automation surface used by graphenectl and Studio. It serves Connect, gRPC and gRPC-Web from the same server door and the same protobuf contract.

Use generated clients from proto/management/v1; do not scrape CLI output. The contract currently contains nine services and 34 methods, summarized in Methods. Transport, authentication, errors and stream rules are in Protocol.

Request context

Every request sends:

Authorization: Bearer <token>
X-Graphene-Namespace: team-a

The namespace header is optional. A namespace-scoped credential acts in its own namespace; an installation-wide admin defaults to default and uses the header to select another. Authorization is checked again in the target namespace.

Browser calls may come from any origin, but cookies are not accepted and every non-preflight call still needs a bearer token.

Resource-first shape

Most domain objects are records addressed as kind/id. Create, read, list, delete, transfer and invoke go through ResourcesAPI; schemas and commands are discovered from kind/<name> records. Dedicated services exist only for bytes, streams, a secret value, a token value, and caller/server information.

This keeps clients generic: a pipeline-brought kind appears without rebuilding the client. Read Resources before implementing a custom client.

Compatibility

Generated code is committed in the server and Studio repositories. There is no published cross-version compatibility window yet; generate clients from the target server revision and test them together. See Compatibility.