GraphQL API overview
CloudBeaver offers a powerful web API through the GraphQL protocol, enabling advanced server interactions and data manipulation.
GraphQL API uses tokens for authentication.
For a full list of available queries, mutations, and types, see the GraphQL API documentation.
The built-in GraphQL console lets you explore the schema, run queries, and test interactions directly in the browser.
Read more about GraphQL console.
Use the built-in server CLI to run a single GraphQL operation from a file - perfect for automation, CI/CD, or headless environments.
Read more about running GraphQL with the CLI.
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.
For details, see Audit logging.
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.
- Getting started
- Create connection
- Connection network options
- Supported databases
-
Drivers management
- Database authentication methods
- Database navigator
- Properties editor
- Data editor
- SQL editor
-
Entity relation diagrams
- Cloud services
-
AI Smart assistance
- Data transfer
- General user guide
- Administration
- Server configuration
-
Server security and access configuration
- Authentication methods
- Access management
- Proxy configuration
-
Secret management
- Logs
-
Query manager
- Workspace location
- Command line parameters
-
Session manager
- Deployment options
- CloudBeaver Editions
- FAQ
- Development