Clouds API schema

service.clouds.graphqls

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

`cloudConfigurationProperties`

Description

Cloud configuration properties used to build an administration form.

Response

Returns a CBCloudConfigurationValues!

Arguments

Name	Description
`providerId` - `ID!`
`configuration` - `CBCloudConfigurationValuesInput`

Example

Query

query cloudConfigurationProperties(
  $providerId: ID!,
  $configuration: CBCloudConfigurationValuesInput
) {
  cloudConfigurationProperties(
    providerId: $providerId,
    configuration: $configuration
  ) {
    properties {
      ...ObjectPropertyInfoFragment
    }
    credentials {
      ...ObjectPropertyInfoFragment
    }
  }
}

Variables

{
  "providerId": "<id>",
  "configuration": CBCloudConfigurationValuesInput
}

Response

{
  "data": {
    "cloudConfigurationProperties": {
      "properties": [ObjectPropertyInfo],
      "credentials": [ObjectPropertyInfo]
    }
  }
}

Queries

`cloudListConfigurationProviders`

Description

List cloud configuration provider IDs available to administrators.

Response

Returns [ID!]!

Example

Query

query cloudListConfigurationProviders {
  cloudListConfigurationProviders
}

Response

{
  "data": {
    "cloudListConfigurationProviders": [
      "<id>"
    ]
  }
}

Queries

`cloudListConfigurations`

Description

List cloud configurations available to administrators.

Response

Returns [CBCloudConfiguration!]!

Arguments

Name	Description
`providerId` - `ID`

Example

Query

query cloudListConfigurations($providerId: ID) {
  cloudListConfigurations(providerId: $providerId) {
    providerId
    id
    name
    preconfigured
    configuration {
      ...CBCloudConfigurationValuesFragment
    }
  }
}

Variables

{"providerId": "<id>"}

Response

{
  "data": {
    "cloudListConfigurations": [
      {
        "providerId": "<id>",
        "id": "<id>",
        "name": "<string>",
        "preconfigured": "<boolean>",
        "configuration": CBCloudConfigurationValues
      }
    ]
  }
}

Queries

`listClouds`

Description

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

Response

Returns [CBCloud!]

Example

Query

query listClouds {
  listClouds {
    id
    name
    authProvider
    authRequired
  }
}

Response

{
  "data": {
    "listClouds": [
      {
        "id": "<string>",
        "name": "<string>",
        "authProvider": "<string>",
        "authRequired": "<boolean>"
      }
    ]
  }
}

Mutations

`cloudCreateConfiguration`

Response

Returns a CBCloudConfiguration!

Arguments

Name	Description
`input` - `CBCloudConfigurationInput!`

Example

Query

mutation cloudCreateConfiguration($input: CBCloudConfigurationInput!) {
  cloudCreateConfiguration(input: $input) {
    providerId
    id
    name
    preconfigured
    configuration {
      ...CBCloudConfigurationValuesFragment
    }
  }
}

Variables

{"input": CBCloudConfigurationInput}

Response

{
  "data": {
    "cloudCreateConfiguration": {
      "providerId": "<id>",
      "id": "<id>",
      "name": "<string>",
      "preconfigured": "<boolean>",
      "configuration": CBCloudConfigurationValues
    }
  }
}

Mutations

`cloudDeleteConfiguration`

Response

Returns a Boolean!

Arguments

Name	Description
`providerId` - `ID!`
`cloudId` - `ID!`

Example

Query

mutation cloudDeleteConfiguration(
  $providerId: ID!,
  $cloudId: ID!
) {
  cloudDeleteConfiguration(
    providerId: $providerId,
    cloudId: $cloudId
  )
}

Variables

{"providerId": "<id>", "cloudId": "<id>"}

Response

{
  "data": {
    "cloudDeleteConfiguration": "<boolean>"
  }
}

Mutations

`cloudUpdateConfiguration`

Response

Returns a CBCloudConfiguration!

Arguments

Name	Description
`input` - `CBCloudConfigurationInput!`

Example

Query

mutation cloudUpdateConfiguration($input: CBCloudConfigurationInput!) {
  cloudUpdateConfiguration(input: $input) {
    providerId
    id
    name
    preconfigured
    configuration {
      ...CBCloudConfigurationValuesFragment
    }
  }
}

Variables

{"input": CBCloudConfigurationInput}

Response

{
  "data": {
    "cloudUpdateConfiguration": {
      "providerId": "<id>",
      "id": "<id>",
      "name": "<string>",
      "preconfigured": "<boolean>",
      "configuration": CBCloudConfigurationValues
    }
  }
}

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).
`authRequired` - `Boolean!`	Whether the cloud requires credentials from the current user session.

Example

{
  "id": "<string>",
  "name": "<string>",
  "authProvider": "<string>",
  "authRequired": "<boolean>"
}

Types

CBCloudConfiguration

Fields

Field Name	Description
`providerId` - `ID!`
`id` - `ID!`
`name` - `String!`
`preconfigured` - `Boolean!`
`configuration` - `CBCloudConfigurationValues!`	Provider-specific configuration properties with their current values. Secure values are masked.

Example

{
  "providerId": "<id>",
  "id": "<id>",
  "name": "<string>",
  "preconfigured": "<boolean>",
  "configuration": CBCloudConfigurationValues
}

Types

CBCloudConfigurationInput

Fields

Input Field	Description
`providerId` - `ID!`
`cloudId` - `ID!`
`cloudName` - `String!`
`configuration` - `CBCloudConfigurationValuesInput`	Provider-specific configuration values. Omitted values remain unchanged on update.

Example

{
  "providerId": "<id>",
  "cloudId": "<id>",
  "cloudName": "<string>",
  "configuration": CBCloudConfigurationValuesInput
}

Types

CBCloudConfigurationValues

Fields

Field Name	Description
`properties` - `[ObjectPropertyInfo!]!`	Cloud configuration properties excluding credentials.
`credentials` - `[ObjectPropertyInfo!]!`	Cloud credentials properties. Secure values are masked.

Example

{
  "properties": [ObjectPropertyInfo],
  "credentials": [ObjectPropertyInfo]
}

Types

CBCloudConfigurationValuesInput

Fields

Input Field	Description
`properties` - `Object`	Cloud configuration properties excluding credentials.
`credentials` - `Object`	Cloud credentials properties.

Example

{"properties": "<object>", "credentials": "<object>"}

Types

Condition

Description

Represents a dynamic condition for a property, such as visibility or read-only state

Fields

Field Name	Description
`expression` - `String!`	The logical expression that defines when the condition applies
`conditionType` - `ConditionType!`	The type of condition (e.g., HIDE or READ_ONLY)

Example

{"expression": "<string>", "conditionType": "HIDE"}

Types

ConditionType

Values

Enum Value	Description
`HIDE`	hiding property condition
`READ_ONLY`	restriction for setting a property value

Example

"HIDE"

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

"<float>"

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"<id>"

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

"<int>"

Types

Object

Description

Any object (JSON)

Example

"<object>"

Types

ObjectPropertyInfo

Description

Information about the object property used to generate its UI

Fields

Field Name	Description
`id` - `String`	Unique property identifier
`displayName` - `String`	Human-readable name
`description` - `String`	Property description
`documentationPath` - `String`	Documentation path
`hint` - `String`	Usage hint for the property
`category` - `String`	Property category (may be used if object has a lot of properties)
`dataType` - `String`	Property data type (e.g., int, String)
`value` - `Object`	Property value (can be resource-intensive for some properties, e.g., RowCount for tables)
`validValues` - `[Object]`	List of allowed values (for enumerable properties)
`allowCustomValue` - `Boolean!`	Whether values outside validValues may be entered
`defaultValue` - `Object`	Default property value
`constraints` - `PropertyConstraints`	Constraints for the property value
`length` - `ObjectPropertyLength!`	Property value length
`features` - `[String!]!`	List of supported features (e.g., system, hidden, inherited, foreign, expensive)
`order` - `Int!`	Order position
`supportedConfigurationTypes` - `[String!]`	Supported configuration types (for driver properties)
`required` - `Boolean!`	Is the property required
`scopes` - `[String!]`	List of preference scopes (e.g., global, user)
`conditions` - `[Condition!]`	Dynamic conditions for the property (e.g., visibility or read-only)

Example

{
  "id": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "documentationPath": "<string>",
  "hint": "<string>",
  "category": "<string>",
  "dataType": "<string>",
  "value": "<object>",
  "validValues": ["<object>"],
  "allowCustomValue": "<boolean>",
  "defaultValue": "<object>",
  "constraints": PropertyConstraints,
  "length": "TINY",
  "features": ["<string>"],
  "order": "<int>",
  "supportedConfigurationTypes": ["<string>"],
  "required": "<boolean>",
  "scopes": ["<string>"],
  "conditions": [Condition]
}

Types

ObjectPropertyLength

Values

Enum Value	Description
`TINY`	1 character
`SHORT`	20 characters
`MEDIUM`	<= 64 characters
`LONG`	Full line length. The default
`MULTILINE`	Multi-line long text

Example

"TINY"

Types

PropertyConstraints

Fields

Field Name	Description
`min` - `Float`	Minimum allowed value for numeric properties
`max` - `Float`	Maximum allowed value for numeric properties

Example

{"min": "<float>", "max": "<float>"}

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