CloudBeaver Documentation

DOWNLOAD pdf

Server API explorer

Table of contents

Overview

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 develMode is set to true in your configuration to enable access.

Accessing the GraphQL console

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:

http://localhost:${serverPort}/${serviceURI}/gql/console

Replace ${serverPort} and ${serviceURI} with the actual server port and service URI values set in your configuration.

For information on configuring these variables, see the Server configuration guide.

Generating API tokens

To generate an API token for authentication, see the Generate API access token guide.