Server API explorer
CloudBeaver offers a powerful web API through the GraphQL protocol, enabling advanced server interactions and data manipulation.
Note: The API explorer (GraphQL console) is only available when the server is running in Development mode. Ensure that
develModeis set totruein your configuration to enable access.
The GraphQL console is an interface that allows you to test and interact with the API. You can access it by navigating to the following URL:
https://${serverAddress}/api/gql/console
Replace ${serverAddress} with the actual server host name (e.g. localhost).
You can also explore public API on our public demo server
For information on configuring these variables, see the Server configuration guide.
To generate an API token for authentication, see the Generate API access token guide.
- 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