starred/cloudbeaver
1
0
Fork 0
mirror of https://github.com/dbeaver/cloudbeaver.git synced 2026-03-04 08:52:27 -05:00
Code Issues 420 Projects Packages Wiki Activity
Page: GraphQL API overview
Pages
API and integration AWS Cloud explorer AWS IAM AWS OpenID Authentication AWS OpenID database access via Okta AWS Overview AWS SAML database access via Okta AWS Settings Access to an existing database connection with a link Accessibility Guide Adding new database drivers Admin Password Recovery Administration Users Provisioning Administration Anonymous Access Configuration Authentication Database Native Authentication Microsoft Entra ID Authentication MongoDB Authentication Oracle Wallet Authentication PostgreSQL Pgpass Authentication Salesforce Authentication methods Auto and Manual commit modes Azure Permissions Basic operations Build and deploy Client Side Scripting Cloud Explorer Cloud Storage CloudBeaver AWS deployment on the AWS Marketplace CloudBeaver Community deployment from docker image CloudBeaver Community deployment in Google Cloud CloudBeaver Community deployment in Microsoft Azure CloudBeaver Community deployment on the AWS Marketplace CloudBeaver Deployment CloudBeaver Enterprise Update CloudBeaver Enterprise deployment from docker compose CloudBeaver Enterprise deployment from docker image CloudBeaver Enterprise deployment in AWS CloudBeaver Enterprise deployment in Google Cloud CloudBeaver Enterprise deployment in Microsoft Azure CloudBeaver Enterprise CloudBeaver SSL certificate configuration CloudBeaver Styling components CloudBeaver Workspace Backup CloudBeaver and Nginx CloudBeaver customer technical support information CloudBeaver localization CloudBeaver overview CloudBeaver release cycles Code of Conduct Cognito OpenID Authentication Command line parameters Configuring HTTPS for Jetty server Configuring server datasources Connect Tableau to a database using DBeaver Proxy Driver Connection Management Connection Templates Management Connection configuration Contribute your code Create Connection Custom Plugin DB Navigator Settings menu DB Navigator folders DB Navigator toolbar DBeaver Proxy driver Data Filters Data Ordering Data editor Data export Data import Database Navigator Database Object Editor Database driver CSV Database driver Files MultiSource Database driver JSON Database driver Parquet Database driver XLSX Database driver XML Demo Server Develop in Eclipse Develop in IDEA Develop in VS Code Differences between license types Domain Manager Driver management Drivers Management Entity Diagrams FAQ File based driver properties Frontend development guidelines Frontend technical overview Generate API access token Getting started Global Permissions Google authentication GraphQL API overview Grouping Panel Home How to Import License How to Migrate your CloudBeaver Enterprise Workspace How to Reassign License How to Update License How to access query history database How to change Java security properties How to connect DBeaver or CloudBeaver to PostgreSQL on a separate VM in Azure Initial data configuration JSON and Document View JWT authentication Kerberos Authentication LDAP Authentication Local Access Authentication Local Preferences Log Viewer Log customization Managing Charts Managing Preferences Managing cloud deployed services Microsoft Entra ID authentication Multi server license Multiple Server URLs NTLM User Authentication Okta OpenID Authentication OpenID Package localization Password policy Plugin system Pre configured permissions for connections Product configuration parameters Product settings authentication Product settings connections Product settings data export Product settings data spreadsheet Product settings erd Product settings navigation tree Properties Editor Proxy Configuration Query Execution Plan Query History Query Manager Query manager database configuration Resource Loading Resource Manager Result Details Panel Reverse proxy header authentication Run GraphQL requests from CLI SAML SQL Assist and Auto Complete SQL Editor SQL Formatting SSH Configuration SSL Configuration Search and Replace Secret Providers Security in CloudBeaver Server API explorer Server Architecture Server Database Server Output Server configuration administration Server configuration Session Manager Settings Shortcuts Simple and Advanced View Single Sign On Snowflake OpenID database access via Okta Supported databases Teams User credentials storage Users Value Panel Visual Query Builder WebSockets Working with spatial GIS data Workspace Location Workspace on AWS and S3 Storage
3 GraphQL API overview
dbeaver-devops edited this page 2025-09-15 15:36:04 +00:00
Unescape Escape
Table of Contents
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Table of contents

CloudBeaver offers a powerful web API through the GraphQL protocol, enabling advanced server interactions and data manipulation.

Authentication

GraphQL API uses tokens for authentication.

See how to get and use a token.

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.

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.

Read more about running GraphQL with the CLI.

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.

CloudBeaver Documentation

CloudBeaver - Web Database Manager