Clouds API schema

service.clouds.graphqls

This API is available in Enterprise and AWS editions only.

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.

API Endpoints
https://your-server-address/api/gql

Queries

listClouds

Description

List of available clouds (AWS, GCP, Azure, etc.)

Response

Returns [CBCloud!]

Example

Query
query listClouds {
  listClouds {
    id
    name
    authProvider
  }
}
Response
{
  "data": {
    "listClouds": [
      {"id": "<string>", "name": "<string>", "authProvider": "<string>"}
    ]
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

CBCloud

Fields
Field Name Description
id - String! Unique identifier of the cloud.
name - String! Display name of the cloud.
authProvider - String! Auth provider ID used for the cloud (see AuthProviderInfo).
Example
{"id": "<string>", "name": "<string>", "authProvider": "<string>"}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"<string>"
Documentation by Anvil SpectaQL