GraphQL schema reference
Generated from the public schema pkg/graphql/public/schema.public.graphql by make generate-graphql-reference. This reference covers GraphQL fields available to tenant and public clients. Operator-only and service-token-only fields, marked @internal in pkg/graphql/schema.graphql, are not part of the public schema. A field can still require a token, a role, ownership, or a product capability; read its description and the authentication guide.
Domains
Section titled “Domains”| Domain | Queries | Mutations | Subscriptions | Types |
|---|---|---|---|---|
| Streams | 6 | 9 | 0 | 26 |
| Media and storage | 15 | 16 | 0 | 105 |
| Access and playback | 4 | 6 | 0 | 30 |
| Live subscriptions | 0 | 0 | 13 | 60 |
| Analytics | 1 | 0 | 0 | 122 |
| Webhooks | 5 | 9 | 0 | 24 |
| Incidents | 2 | 3 | 0 | 7 |
| Account and tenant | 1 | 5 | 0 | 14 |
| Billing and usage | 13 | 12 | 0 | 61 |
| Clusters and infrastructure | 25 | 16 | 0 | 58 |
| Platform | 4 | 0 | 0 | 11 |
| Skipper | 5 | 3 | 0 | 6 |
| Support conversations | 3 | 2 | 0 | 8 |
| Shared types | – | – | – | 69 |
How to read this reference
Section titled “How to read this reference”- Each domain page lists its root queries, mutations, and subscriptions, then the types that only that domain’s root fields reach. Types reached from two or more domains are on Shared types.
- A root field shows its GraphQL signature, return type, arguments with defaults, description, and deprecation. Every type name links to its definition.
- Experimental until vX.Y.Z marks a field that is public but not stable yet: it graduates or is removed by that platform release, and it is exempt from the schema compatibility check until then. An SDK operation whose root or selected path has such a field is marked the same way in the SDK table and in its SDK doc comment; an SDK release on the same line may drop it.
- SDK lists the generated operations that select a root field, with the TypeScript document, Go function, and Python method names. Python generates subscriptions in its async client only. A path in the Selects column is the field an operation below the root addresses; a type name in it stands for an inline fragment on that type (
node.<Type>.<field>selectsnode(id:) { ... on <Type> { <field> } }). - Every root field that is not deprecated and returns data of its own has an operation of its own. A namespace root (
Query.analytics) returns an object whose data sits only behind argument-taking fields, at any depth, so it has no operation of its own; each of those argument fields has one, listed under the root. A deprecated root field has no generated operation; send a GraphQL document through each SDK’s raw client. See the SDK guide.