GraphQL API overview
CloudBeaver offers a powerful web API through the GraphQL protocol, enabling advanced server interactions and data manipulation.
Authentication¶
GraphQL API uses tokens for authentication.
Info
API documentation¶
For a full list of available queries, mutations, and types, see the GraphQL API documentation.
Console¶
The built-in GraphQL console lets you explore the schema, run queries, and test interactions directly in the browser.
Info
Read more about GraphQL console.
CLI¶
Use the built-in server CLI to run a single GraphQL operation from a file - perfect for automation, CI/CD, or headless environments.
Info
Read more about running GraphQL with the CLI.
Audit logging¶
For monitoring API activity, you can use the Audit logging panel. When enabled, it records API requests and stores information about the user, timestamp, endpoint, IP address, and execution result.
Info
For details, see Audit logging.
Examples¶
See usage examples in the cloudbeaver-graphql-examples repository.
You’ll find queries for signing in, connecting to databases, running SQL scripts, and managing sessions.