General stuff schema
service.connection.graphqls, service.core.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/gqlQueries
authModels
Description
Returns list of available database auth models
Response
Returns [DatabaseAuthModel!]!
Example
Query
query authModels {
authModels {
id
displayName
description
icon
requiresLocalConfiguration
requiredAuth
properties {
...ObjectPropertyInfoFragment
}
}
}
Response
{
"data": {
"authModels": [
{
"id": "<id>",
"displayName": "<string>",
"description": "<string>",
"icon": "<string>",
"requiresLocalConfiguration": "<boolean>",
"requiredAuth": "<string>",
"properties": [ObjectPropertyInfo]
}
]
}
}
connectionFolders
Description
Returns list of connection folders
Response
Returns [ConnectionFolderInfo!]!
Example
Query
query connectionFolders(
$projectId: ID,
$path: ID
) {
connectionFolders(
projectId: $projectId,
path: $path
) {
id
projectId
description
}
}
Variables
{"projectId": "<id>", "path": "<id>"}
Response
{
"data": {
"connectionFolders": [
{"id": "<id>", "projectId": "<id>", "description": "<string>"}
]
}
}
connectionInfo
Description
Returns connection info
Response
Returns a ConnectionInfo!
Example
Query
query connectionInfo(
$projectId: ID!,
$id: ID!
) {
connectionInfo(
projectId: $projectId,
id: $id
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{"projectId": "<id>", "id": "<id>"}
Response
{
"data": {
"connectionInfo": {
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
}
}
driverList
Description
Returns list of available drivers
Response
Returns [DriverInfo!]!
Arguments
| Name | Description |
|---|---|
id - ID
|
Example
Query
query driverList($id: ID) {
driverList(id: $id) {
id
name
description
icon
iconBig
driverId
providerId
driverClassName
defaultHost
defaultPort
defaultDatabase
defaultServer
defaultUser
sampleURL
driverInfoURL
driverPropertiesURL
embedded
enabled
requiresServerName
requiresDatabaseName
useCustomPage
licenseRequired
license
custom
promotedScore
driverProperties {
...ObjectPropertyInfoFragment
}
driverParameters
mainProperties {
...ObjectPropertyInfoFragment
}
providerProperties {
...ObjectPropertyInfoFragment
}
expertSettingsProperties {
...ObjectPropertyInfoFragment
}
anonymousAccess
defaultAuthModel
applicableAuthModels
applicableNetworkHandlers
configurationTypes
downloadable
driverInstalled
driverLibraries {
...DriverLibraryInfoFragment
}
safeEmbeddedDriver
}
}
Variables
{"id": "<id>"}
Response
{
"data": {
"driverList": [
{
"id": "<id>",
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"iconBig": "<string>",
"driverId": "<id>",
"providerId": "<id>",
"driverClassName": "<string>",
"defaultHost": "<string>",
"defaultPort": "<string>",
"defaultDatabase": "<string>",
"defaultServer": "<string>",
"defaultUser": "<string>",
"sampleURL": "<string>",
"driverInfoURL": "<string>",
"driverPropertiesURL": "<string>",
"embedded": "<boolean>",
"enabled": "<boolean>",
"requiresServerName": "<boolean>",
"requiresDatabaseName": "<boolean>",
"useCustomPage": "<boolean>",
"licenseRequired": "<boolean>",
"license": "<string>",
"custom": "<boolean>",
"promotedScore": "<int>",
"driverProperties": [ObjectPropertyInfo],
"driverParameters": "<object>",
"mainProperties": [ObjectPropertyInfo],
"providerProperties": [ObjectPropertyInfo],
"expertSettingsProperties": [ObjectPropertyInfo],
"anonymousAccess": "<boolean>",
"defaultAuthModel": "<id>",
"applicableAuthModels": ["<id>"],
"applicableNetworkHandlers": ["<id>"],
"configurationTypes": ["MANUAL"],
"downloadable": "<boolean>",
"driverInstalled": "<boolean>",
"driverLibraries": [DriverLibraryInfo],
"safeEmbeddedDriver": "<boolean>"
}
]
}
}
listConnectionDriverProperties
Description
Returns connection driver properties based on configuration
Response
Returns [ObjectPropertyInfo!]!
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
config - ConnectionConfig!
|
Example
Query
query listConnectionDriverProperties(
$projectId: ID!,
$config: ConnectionConfig!
) {
listConnectionDriverProperties(
projectId: $projectId,
config: $config
) {
id
displayName
description
hint
category
dataType
value
validValues
defaultValue
length
features
order
supportedConfigurationTypes
required
scopes
conditions {
...ConditionFragment
}
}
}
Variables
{"projectId": "<id>", "config": ConnectionConfig}
Response
{
"data": {
"listConnectionDriverProperties": [
{
"id": "<string>",
"displayName": "<string>",
"description": "<string>",
"hint": "<string>",
"category": "<string>",
"dataType": "<string>",
"value": "<object>",
"validValues": ["<object>"],
"defaultValue": "<object>",
"length": "TINY",
"features": ["<string>"],
"order": "<int>",
"supportedConfigurationTypes": ["<string>"],
"required": "<boolean>",
"scopes": ["<string>"],
"conditions": [Condition]
}
]
}
}
listConnectionTypes
Response
Returns [ConnectionType!]!
Example
Query
query listConnectionTypes {
listConnectionTypes {
id
name
description
colorLight
colorDark
autocommit
confirmExecute
confirmDataChange
smartCommit
smartCommitRecover
autoCloseTransactions
closeIdleTransactionPeriod
autoCloseConnections
closeIdleConnectionPeriod
predefined
}
}
Response
{
"data": {
"listConnectionTypes": [
{
"id": "<id>",
"name": "<string>",
"description": "<string>",
"colorLight": "<string>",
"colorDark": "<string>",
"autocommit": "<boolean>",
"confirmExecute": "<boolean>",
"confirmDataChange": "<boolean>",
"smartCommit": "<boolean>",
"smartCommitRecover": "<boolean>",
"autoCloseTransactions": "<boolean>",
"closeIdleTransactionPeriod": "<int>",
"autoCloseConnections": "<boolean>",
"closeIdleConnectionPeriod": "<int>",
"predefined": "<boolean>"
}
]
}
}
listProjects
Description
Returns list of accessible user projects
Response
Returns [ProjectInfo!]!
Example
Query
query listProjects {
listProjects {
id
global
shared
name
description
canEditDataSources
canViewDataSources
canEditResources
canViewResources
resourceTypes {
...RMResourceTypeFragment
}
}
}
Response
{
"data": {
"listProjects": [
{
"id": "<string>",
"global": "<boolean>",
"shared": "<boolean>",
"name": "<string>",
"description": "<string>",
"canEditDataSources": "<boolean>",
"canViewDataSources": "<boolean>",
"canEditResources": "<boolean>",
"canViewResources": "<boolean>",
"resourceTypes": [RMResourceType]
}
]
}
}
marketplaceProductInfo
Description
Returns information about marketplace product (e.g. product from AWS Marketplace with a specific pricing)
Response
Returns a MarketplaceProductInfo
Example
Query
query marketplaceProductInfo {
marketplaceProductInfo {
dimensionPricingInfo {
...DimensionPricingInfoFragment
}
}
}
Response
{
"data": {
"marketplaceProductInfo": {
"dimensionPricingInfo": [DimensionPricingInfo]
}
}
}
networkHandlers
Description
Returns list of available network handlers
Response
Returns [NetworkHandlerDescriptor!]!
Example
Query
query networkHandlers {
networkHandlers {
id
codeName
label
description
secured
type
properties {
...ObjectPropertyInfoFragment
}
}
}
Response
{
"data": {
"networkHandlers": [
{
"id": "<id>",
"codeName": "<string>",
"label": "<string>",
"description": "<string>",
"secured": "<boolean>",
"type": "TUNNEL",
"properties": [ObjectPropertyInfo]
}
]
}
}
productSettings
Description
Returns product settings
Response
Returns a ProductSettings!
Example
Query
query productSettings {
productSettings {
groups {
...ProductSettingsGroupFragment
}
settings {
...ObjectPropertyInfoFragment
}
}
}
Response
{
"data": {
"productSettings": {
"groups": [ProductSettingsGroup],
"settings": [ObjectPropertyInfo]
}
}
}
readSessionLog
Description
Reads session log entries
Response
Returns [LogEntry!]!
Example
Query
query readSessionLog(
$maxEntries: Int,
$clearEntries: Boolean
) {
readSessionLog(
maxEntries: $maxEntries,
clearEntries: $clearEntries
) {
time
type
message
stackTrace
}
}
Variables
{"maxEntries": "<int>", "clearEntries": "<boolean>"}
Response
{
"data": {
"readSessionLog": [
{
"time": "<datetime>",
"type": "<string>",
"message": "<string>",
"stackTrace": "<string>"
}
]
}
}
serverConfig
Description
Returns server config
Response
Returns a ServerConfig!
Example
Query
query serverConfig {
serverConfig {
serverURL
rootURI
hostName
containerId
defaultAuthRole
defaultUserTeam
sessionExpireTime
localHostAddress
redirectOnFederatedAuth
enabledAuthProviders
passwordPolicyConfiguration {
...PasswordPolicyConfigFragment
}
forceHttps
supportedHosts
bindSessionToIp
name
version
workspaceId
anonymousAccessEnabled
supportsCustomConnections
resourceManagerEnabled
secretManagerEnabled
publicCredentialsSaveEnabled
adminCredentialsSaveEnabled
licenseRequired
licenseValid
licenseStatus
configurationMode
developmentMode
distributed
enabledFeatures
disabledBetaFeatures
serverFeatures
supportedLanguages {
...ServerLanguageFragment
}
productConfiguration
productInfo {
...ProductInfoFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
disabledDrivers
resourceQuotas
licenseUsersModificationEnabled
}
}
Response
{
"data": {
"serverConfig": {
"serverURL": "<string>",
"rootURI": "<string>",
"hostName": "<string>",
"containerId": "<string>",
"defaultAuthRole": "<string>",
"defaultUserTeam": "<string>",
"sessionExpireTime": "<int>",
"localHostAddress": "<string>",
"redirectOnFederatedAuth": "<boolean>",
"enabledAuthProviders": ["<id>"],
"passwordPolicyConfiguration": PasswordPolicyConfig,
"forceHttps": "<boolean>",
"supportedHosts": ["<string>"],
"bindSessionToIp": "<string>",
"name": "<string>",
"version": "<string>",
"workspaceId": "<id>",
"anonymousAccessEnabled": "<boolean>",
"supportsCustomConnections": "<boolean>",
"resourceManagerEnabled": "<boolean>",
"secretManagerEnabled": "<boolean>",
"publicCredentialsSaveEnabled": "<boolean>",
"adminCredentialsSaveEnabled": "<boolean>",
"licenseRequired": "<boolean>",
"licenseValid": "<boolean>",
"licenseStatus": "<string>",
"configurationMode": "<boolean>",
"developmentMode": "<boolean>",
"distributed": "<boolean>",
"enabledFeatures": ["<id>"],
"disabledBetaFeatures": ["<id>"],
"serverFeatures": ["<id>"],
"supportedLanguages": [ServerLanguage],
"productConfiguration": "<object>",
"productInfo": ProductInfo,
"defaultNavigatorSettings": NavigatorSettings,
"disabledDrivers": ["<id>"],
"resourceQuotas": "<object>",
"licenseUsersModificationEnabled": "<boolean>"
}
}
}
sessionPermissions
Description
Returns session permissions
Response
Returns [ID]!
Example
Query
query sessionPermissions {
sessionPermissions
}
Response
{"data": {"sessionPermissions": ["<id>"]}}
sessionState
Description
Returns session state ( initialize if not )
Response
Returns a SessionInfo!
Example
Query
query sessionState {
sessionState {
createTime
lastAccessTime
locale
cacheExpired
connections {
...ConnectionInfoFragment
}
actionParameters
valid
remainingTime
}
}
Response
{
"data": {
"sessionState": {
"createTime": "<string>",
"lastAccessTime": "<string>",
"locale": "<string>",
"cacheExpired": "<boolean>",
"connections": [ConnectionInfo],
"actionParameters": "<object>",
"valid": "<boolean>",
"remainingTime": "<int>"
}
}
}
systemInfo
Description
Returns server system information properties
Response
Returns [ObjectPropertyInfo!]!
Example
Query
query systemInfo {
systemInfo {
id
displayName
description
hint
category
dataType
value
validValues
defaultValue
length
features
order
supportedConfigurationTypes
required
scopes
conditions {
...ConditionFragment
}
}
}
Response
{
"data": {
"systemInfo": [
{
"id": "<string>",
"displayName": "<string>",
"description": "<string>",
"hint": "<string>",
"category": "<string>",
"dataType": "<string>",
"value": "<object>",
"validValues": ["<object>"],
"defaultValue": "<object>",
"length": "TINY",
"features": ["<string>"],
"order": "<int>",
"supportedConfigurationTypes": ["<string>"],
"required": "<boolean>",
"scopes": ["<string>"],
"conditions": [Condition]
}
]
}
}
userConnections
Description
Returns list of user connections
Response
Returns [ConnectionInfo!]!
Example
Query
query userConnections(
$projectId: ID,
$id: ID,
$projectIds: [ID!]
) {
userConnections(
projectId: $projectId,
id: $id,
projectIds: $projectIds
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{"projectId": "<id>", "id": "<id>", "projectIds": "<id>"}
Response
{
"data": {
"userConnections": [
{
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
]
}
}
Mutations
asyncTaskCancel
Description
Cancel async task by ID
asyncTaskInfo
Description
Get async task info by ID
Response
Returns an AsyncTaskInfo!
Example
Query
mutation asyncTaskInfo(
$id: String!,
$removeOnFinish: Boolean!
) {
asyncTaskInfo(
id: $id,
removeOnFinish: $removeOnFinish
) {
id
name
running
status
error {
...ServerErrorFragment
}
taskResult
}
}
Variables
{"id": "<string>", "removeOnFinish": "<boolean>"}
Response
{
"data": {
"asyncTaskInfo": {
"id": "<string>",
"name": "<string>",
"running": "<boolean>",
"status": "<string>",
"error": ServerError,
"taskResult": "<object>"
}
}
}
changeSessionLanguage
Description
Change session language to specified
closeConnection
Description
Disconnect from the database
Response
Returns a ConnectionInfo!
Example
Query
mutation closeConnection(
$id: ID!,
$projectId: ID
) {
closeConnection(
id: $id,
projectId: $projectId
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{"id": "<id>", "projectId": "<id>"}
Response
{
"data": {
"closeConnection": {
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
}
}
closeSession
Description
Destroy session
Response
Returns a Boolean
Example
Query
mutation closeSession {
closeSession
}
Response
{"data": {"closeSession": "<boolean>"}}
copyConnectionFromNode
Description
Copies connection configuration from node
Response
Returns a ConnectionInfo!
Arguments
| Name | Description |
|---|---|
nodePath - String!
|
|
config - ConnectionConfig
|
|
projectId - ID
|
Example
Query
mutation copyConnectionFromNode(
$nodePath: String!,
$config: ConnectionConfig,
$projectId: ID
) {
copyConnectionFromNode(
nodePath: $nodePath,
config: $config,
projectId: $projectId
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{
"nodePath": "<string>",
"config": ConnectionConfig,
"projectId": "<id>"
}
Response
{
"data": {
"copyConnectionFromNode": {
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
}
}
createConnection
Description
Create new custom connection
Response
Returns a ConnectionInfo!
Arguments
| Name | Description |
|---|---|
config - ConnectionConfig!
|
|
projectId - ID
|
Example
Query
mutation createConnection(
$config: ConnectionConfig!,
$projectId: ID
) {
createConnection(
config: $config,
projectId: $projectId
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{"config": ConnectionConfig, "projectId": "<id>"}
Response
{
"data": {
"createConnection": {
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
}
}
createConnectionFolder
Description
Create new folder for connections
Response
Returns a ConnectionFolderInfo!
Example
Query
mutation createConnectionFolder(
$parentFolderPath: ID,
$folderName: String!,
$projectId: ID
) {
createConnectionFolder(
parentFolderPath: $parentFolderPath,
folderName: $folderName,
projectId: $projectId
) {
id
projectId
description
}
}
Variables
{"parentFolderPath": "<id>", "folderName": "<string>", "projectId": "<id>"}
Response
{
"data": {
"createConnectionFolder": {
"id": "<id>",
"projectId": "<id>",
"description": "<string>"
}
}
}
createConnectionType
Description
Creates a new connection type
Response
Returns a ConnectionType!
Arguments
| Name | Description |
|---|---|
config - ConnectionTypeConfigInput!
|
Example
Query
mutation createConnectionType($config: ConnectionTypeConfigInput!) {
createConnectionType(config: $config) {
id
name
description
colorLight
colorDark
autocommit
confirmExecute
confirmDataChange
smartCommit
smartCommitRecover
autoCloseTransactions
closeIdleTransactionPeriod
autoCloseConnections
closeIdleConnectionPeriod
predefined
}
}
Variables
{"config": ConnectionTypeConfigInput}
Response
{
"data": {
"createConnectionType": {
"id": "<id>",
"name": "<string>",
"description": "<string>",
"colorLight": "<string>",
"colorDark": "<string>",
"autocommit": "<boolean>",
"confirmExecute": "<boolean>",
"confirmDataChange": "<boolean>",
"smartCommit": "<boolean>",
"smartCommitRecover": "<boolean>",
"autoCloseTransactions": "<boolean>",
"closeIdleTransactionPeriod": "<int>",
"autoCloseConnections": "<boolean>",
"closeIdleConnectionPeriod": "<int>",
"predefined": "<boolean>"
}
}
}
deleteConnection
Description
Delete specified connection
Example
Query
mutation deleteConnection(
$id: ID!,
$projectId: ID
) {
deleteConnection(
id: $id,
projectId: $projectId
)
}
Variables
{"id": "<id>", "projectId": "<id>"}
Response
{"data": {"deleteConnection": "<boolean>"}}
deleteConnectionFolder
Description
Delete specified connection folder
Example
Query
mutation deleteConnectionFolder(
$folderPath: ID!,
$projectId: ID
) {
deleteConnectionFolder(
folderPath: $folderPath,
projectId: $projectId
)
}
Variables
{"folderPath": "<id>", "projectId": "<id>"}
Response
{
"data": {
"deleteConnectionFolder": "<boolean>"
}
}
deleteConnectionType
Description
Deletes an existing connection type (does not delete predefined connection types)
initConnection
Description
Initiate database connection. User credentials may be (optionally) override default settings.
Response
Returns a ConnectionInfo!
Example
Query
mutation initConnection(
$id: ID!,
$projectId: ID,
$credentials: Object,
$networkCredentials: [NetworkHandlerConfigInput!],
$saveCredentials: Boolean,
$sharedCredentials: Boolean,
$selectedSecretId: String
) {
initConnection(
id: $id,
projectId: $projectId,
credentials: $credentials,
networkCredentials: $networkCredentials,
saveCredentials: $saveCredentials,
sharedCredentials: $sharedCredentials,
selectedSecretId: $selectedSecretId
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{
"id": "<id>",
"projectId": "<id>",
"credentials": "<object>",
"networkCredentials": [NetworkHandlerConfigInput],
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"selectedSecretId": "<string>"
}
Response
{
"data": {
"initConnection": {
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
}
}
openSession
Description
Initialize session
Response
Returns a SessionInfo!
Arguments
| Name | Description |
|---|---|
defaultLocale - String
|
Example
Query
mutation openSession($defaultLocale: String) {
openSession(defaultLocale: $defaultLocale) {
createTime
lastAccessTime
locale
cacheExpired
connections {
...ConnectionInfoFragment
}
actionParameters
valid
remainingTime
}
}
Variables
{"defaultLocale": "<string>"}
Response
{
"data": {
"openSession": {
"createTime": "<string>",
"lastAccessTime": "<string>",
"locale": "<string>",
"cacheExpired": "<boolean>",
"connections": [ConnectionInfo],
"actionParameters": "<object>",
"valid": "<boolean>",
"remainingTime": "<int>"
}
}
}
refreshSessionConnections
Description
Refresh session connection list
Response
Returns a Boolean
Example
Query
mutation refreshSessionConnections {
refreshSessionConnections
}
Response
{
"data": {
"refreshSessionConnections": "<boolean>"
}
}
setObjectSettingsForDatasource
Example
Query
mutation setObjectSettingsForDatasource(
$id: ID!,
$projectId: ID,
$settings: Object!
) {
setObjectSettingsForDatasource(
id: $id,
projectId: $projectId,
settings: $settings
)
}
Variables
{"id": "<id>", "projectId": "<id>", "settings": "<object>"}
Response
{
"data": {
"setObjectSettingsForDatasource": "<object>"
}
}
testConnection
Description
Test connection configuration. Returns remote server version
Response
Returns a ConnectionInfo!
Arguments
| Name | Description |
|---|---|
config - ConnectionConfig!
|
|
projectId - ID
|
Example
Query
mutation testConnection(
$config: ConnectionConfig!,
$projectId: ID
) {
testConnection(
config: $config,
projectId: $projectId
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{"config": ConnectionConfig, "projectId": "<id>"}
Response
{
"data": {
"testConnection": {
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
}
}
testNetworkHandler
Description
Test network handler connectivity
Response
Returns a NetworkEndpointInfo!
Arguments
| Name | Description |
|---|---|
projectId - ID
|
|
connectionId - ID
|
|
config - NetworkHandlerConfigInput!
|
Example
Query
mutation testNetworkHandler(
$projectId: ID,
$connectionId: ID,
$config: NetworkHandlerConfigInput!
) {
testNetworkHandler(
projectId: $projectId,
connectionId: $connectionId,
config: $config
) {
message
clientVersion
serverVersion
}
}
Variables
{
"projectId": "<id>",
"connectionId": "<id>",
"config": NetworkHandlerConfigInput
}
Response
{
"data": {
"testNetworkHandler": {
"message": "<string>",
"clientVersion": "<string>",
"serverVersion": "<string>"
}
}
}
touchSession
use events to update session
Description
Refreshes session on server and returns its state
Response
Returns a Boolean
Example
Query
mutation touchSession {
touchSession
}
Response
{"data": {"touchSession": "<boolean>"}}
updateConnection
Description
Update specified connection
Response
Returns a ConnectionInfo!
Arguments
| Name | Description |
|---|---|
config - ConnectionConfig!
|
|
projectId - ID
|
Example
Query
mutation updateConnection(
$config: ConnectionConfig!,
$projectId: ID
) {
updateConnection(
config: $config,
projectId: $projectId
) {
externalParameters {
...ExternalParametersInfoFragment
}
networkProfile
id
driverId
name
description
host
port
serverName
databaseName
url
mainPropertyValues
expertSettingsValues
keepAliveInterval
autocommit
properties
connected
provided
readOnly
useUrl
saveCredentials
sharedCredentials
sharedSecrets {
...SecretInfoFragment
}
credentialsSaved
authNeeded
folder
nodePath
connectTime
connectionError {
...ServerErrorFragment
}
serverVersion
clientVersion
origin {
...ObjectOriginFragment
}
authModel
authProperties {
...ObjectPropertyInfoFragment
}
providerProperties
networkHandlersConfig {
...NetworkHandlerConfigFragment
}
features
navigatorSettings {
...NavigatorSettingsFragment
}
defaultNavigatorSettings {
...NavigatorSettingsFragment
}
supportedDataFormats
configurationType
canViewSettings
canEdit
canDelete
projectId
requiredAuth
defaultCatalogName
defaultSchemaName
defaultUserPreferences
tools
connectionType
driverConfiguration {
...DriverConfigurationFragment
}
}
}
Variables
{"config": ConnectionConfig, "projectId": "<id>"}
Response
{
"data": {
"updateConnection": {
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
}
}
updateConnectionType
Description
Updates an existing connection type
Response
Returns a ConnectionType!
Arguments
| Name | Description |
|---|---|
config - ConnectionTypeConfigInput!
|
Example
Query
mutation updateConnectionType($config: ConnectionTypeConfigInput!) {
updateConnectionType(config: $config) {
id
name
description
colorLight
colorDark
autocommit
confirmExecute
confirmDataChange
smartCommit
smartCommitRecover
autoCloseTransactions
closeIdleTransactionPeriod
autoCloseConnections
closeIdleConnectionPeriod
predefined
}
}
Variables
{"config": ConnectionTypeConfigInput}
Response
{
"data": {
"updateConnectionType": {
"id": "<id>",
"name": "<string>",
"description": "<string>",
"colorLight": "<string>",
"colorDark": "<string>",
"autocommit": "<boolean>",
"confirmExecute": "<boolean>",
"confirmDataChange": "<boolean>",
"smartCommit": "<boolean>",
"smartCommitRecover": "<boolean>",
"autoCloseTransactions": "<boolean>",
"closeIdleTransactionPeriod": "<int>",
"autoCloseConnections": "<boolean>",
"closeIdleConnectionPeriod": "<int>",
"predefined": "<boolean>"
}
}
}
updateSession
use events to update session
Description
Refreshes session on server and returns session state
Response
Returns a SessionInfo!
Example
Query
mutation updateSession {
updateSession {
createTime
lastAccessTime
locale
cacheExpired
connections {
...ConnectionInfoFragment
}
actionParameters
valid
remainingTime
}
}
Response
{
"data": {
"updateSession": {
"createTime": "<string>",
"lastAccessTime": "<string>",
"locale": "<string>",
"cacheExpired": "<boolean>",
"connections": [ConnectionInfo],
"actionParameters": "<object>",
"valid": "<boolean>",
"remainingTime": "<int>"
}
}
}
Types
AsyncTaskInfo
Description
Async types
Fields
| Field Name | Description |
|---|---|
id - String!
|
Task unique identifier |
name - String
|
Async task name |
running - Boolean!
|
Indicates if the task is currently running |
status - String
|
Current status of the async task |
error - ServerError
|
Error information if the task failed |
taskResult - Object
|
Task result. Can be some kind of identifier to obtain real result using another API function |
Example
{
"id": "<string>",
"name": "<string>",
"running": "<boolean>",
"status": "<string>",
"error": ServerError,
"taskResult": "<object>"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
"<boolean>"
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"}
ConditionType
Values
| Enum Value | Description |
|---|---|
|
|
hiding property condition |
|
|
restriction for setting a property value |
Example
"HIDE"
ConnectionConfig
Description
Configuration of particular connection. Used for new connection create. Includes auth info
Fields
| Input Field | Description |
|---|---|
externalParameters - ExternalParametersInput
|
|
networkProfile - ID
|
Network profile ID that will be used for connection |
connectionId - String
|
used only for testing created connection |
name - String
|
|
description - String
|
|
driverId - ID
|
ID of database driver |
host - String
|
Custom connection parameters (all optional) |
port - String
|
|
serverName - String
|
|
databaseName - String
|
|
mainPropertyValues - Object
|
Host, port, serverName, databaseName are also stored in mainPropertyValues for custom pages |
expertSettingsValues - Object
|
Keep-alive, auto-commit, read-only and other expert settings are stored in expertSettingsValues |
url - String
|
Sets connection URL jdbc:{driver}://{host}[:{port}]/[{database}] |
properties - Object
|
Set properties list |
saveCredentials - Boolean
|
Flag for saving credentials in secure storage |
sharedCredentials - Boolean
|
Flag for using shared credentials. |
authModelId - ID
|
Auth model ID that will be used for connection |
selectedSecretId - ID
|
Secret ID that will be used for connection |
credentials - Object
|
Credentials for the connection (usually user name and password but it may vary for different auth models) |
providerProperties - Object
|
Returns map of provider properties (name/value) |
networkHandlersConfig - [NetworkHandlerConfigInput!]
|
Returns network handlers configuration. Map of id->property map (name/value). |
folder - ID
|
Defines in which connection folder the connection should be created |
configurationType - DriverConfigurationType
|
Configuration type (MANUAL, URL) |
defaultUserPreferences - Object
|
Default user settings for connection |
connectionType - ID
|
Example
{
"externalParameters": ExternalParametersInput,
"networkProfile": "<id>",
"connectionId": "<string>",
"name": "<string>",
"description": "<string>",
"driverId": "<id>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"url": "<string>",
"properties": "<object>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"authModelId": "<id>",
"selectedSecretId": "<id>",
"credentials": "<object>",
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfigInput],
"folder": "<id>",
"configurationType": "MANUAL",
"defaultUserPreferences": "<object>",
"connectionType": "<id>"
}
ConnectionFolderInfo
ConnectionInfo
Description
Connection instance
Fields
| Field Name | Description |
|---|---|
externalParameters - ExternalParametersInfo
|
|
networkProfile - ID
|
References a network profile configured in the project |
id - ID!
|
Connection unique ID |
driverId - ID!
|
ID of the driver that is used for this connection (see DriverInfo) |
name - String!
|
Connection name |
description - String
|
Connection description |
host - String
|
|
port - String
|
|
serverName - String
|
|
databaseName - String
|
|
url - String
|
|
mainPropertyValues - Object
|
Main connection properties. Contains host, port, database, server name fields |
expertSettingsValues - Object
|
Expert connection settings. Contains expert settings properties (like keep-alive interval or auto-commit) that are not often used |
keepAliveInterval - Int!
|
Connection keep-alive interval in seconds |
autocommit - Boolean
|
Defines if the connection is in auto-commit mode |
properties - Object
|
|
connected - Boolean!
|
Indicates if the connection is already connected to the database |
provided - Boolean!
|
|
readOnly - Boolean!
|
Indicates if the connection is read-only (no data modification allowed) |
useUrl - Boolean!
|
Forces connection URL use, host/port/database parameters will be ignored |
saveCredentials - Boolean!
|
Forces credentials save. This flag doesn't work in shared projects. |
sharedCredentials - Boolean!
|
Shared credentials - the same for all users, stored in secure storage. |
sharedSecrets - [SecretInfo!]!
|
|
credentialsSaved - Boolean!
|
Determines that credentials were saved for current user. This field read is slow, it should be read only when it really needed |
authNeeded - Boolean!
|
Determines that additional credentials are needed to connect This field read is slow, it should be read only when it really needed |
folder - ID
|
ID of the connection folder where this connection is stored |
nodePath - String
|
Node path of the connection in the navigator |
connectTime - String
|
Connection time in ISO format |
connectionError - ServerError
|
Connection error if any |
serverVersion - String
|
Server version that is used for this connection |
clientVersion - String
|
Client version that is used for this connection |
origin - ObjectOrigin!
|
|
authModel - ID
|
ID of the auth model that is used for this connection (see authModels) |
authProperties - [ObjectPropertyInfo!]!
|
|
providerProperties - Object!
|
|
networkHandlersConfig - [NetworkHandlerConfig!]!
|
|
features - [String!]!
|
Supported features (provided etc) |
navigatorSettings - NavigatorSettings!
|
Navigator settings for the connection (with user settings applied) |
defaultNavigatorSettings - NavigatorSettings!
|
Default navigator settings for the connection (without user settings applied) |
supportedDataFormats - [ResultDataFormat!]!
|
|
configurationType - DriverConfigurationType
|
|
canViewSettings - Boolean!
|
Access properties |
canEdit - Boolean!
|
|
canDelete - Boolean!
|
|
projectId - ID!
|
|
requiredAuth - String
|
|
defaultCatalogName - String
|
|
defaultSchemaName - String
|
|
defaultUserPreferences - Object
|
Default user settings for connection |
tools - [String!]!
|
List of tools that can be used with this connection. Returns empty list if no tools are available |
connectionType - ID!
|
|
driverConfiguration - DriverConfiguration!
|
Driver configuration |
Example
{
"externalParameters": ExternalParametersInfo,
"networkProfile": "<id>",
"id": "<id>",
"driverId": "<id>",
"name": "<string>",
"description": "<string>",
"host": "<string>",
"port": "<string>",
"serverName": "<string>",
"databaseName": "<string>",
"url": "<string>",
"mainPropertyValues": "<object>",
"expertSettingsValues": "<object>",
"keepAliveInterval": "<int>",
"autocommit": "<boolean>",
"properties": "<object>",
"connected": "<boolean>",
"provided": "<boolean>",
"readOnly": "<boolean>",
"useUrl": "<boolean>",
"saveCredentials": "<boolean>",
"sharedCredentials": "<boolean>",
"sharedSecrets": [SecretInfo],
"credentialsSaved": "<boolean>",
"authNeeded": "<boolean>",
"folder": "<id>",
"nodePath": "<string>",
"connectTime": "<string>",
"connectionError": ServerError,
"serverVersion": "<string>",
"clientVersion": "<string>",
"origin": ObjectOrigin,
"authModel": "<id>",
"authProperties": [ObjectPropertyInfo],
"providerProperties": "<object>",
"networkHandlersConfig": [NetworkHandlerConfig],
"features": ["<string>"],
"navigatorSettings": NavigatorSettings,
"defaultNavigatorSettings": NavigatorSettings,
"supportedDataFormats": ["resultset"],
"configurationType": "MANUAL",
"canViewSettings": "<boolean>",
"canEdit": "<boolean>",
"canDelete": "<boolean>",
"projectId": "<id>",
"requiredAuth": "<string>",
"defaultCatalogName": "<string>",
"defaultSchemaName": "<string>",
"defaultUserPreferences": "<object>",
"tools": ["<string>"],
"connectionType": "<id>",
"driverConfiguration": DriverConfiguration
}
ConnectionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the connection type |
name - String!
|
Human-readable name of the connection type |
description - String
|
Description of the connection type |
colorLight - String!
|
Color of the connection type (for light theme) |
colorDark - String
|
Alternative color of the connection type (for dark theme) |
autocommit - Boolean!
|
Is autocommit enabled for this connection type |
confirmExecute - Boolean!
|
Confirm execution of queries for this connection type |
confirmDataChange - Boolean!
|
Confirm data change operations (INSERT, UPDATE, DELETE) for this connection type |
smartCommit - Boolean!
|
Smart commit mode is enabled for this connection type |
smartCommitRecover - Boolean!
|
Recover smart commit mode is enabled for this connection type |
autoCloseTransactions - Boolean!
|
Auto-close transactions is enabled for this connection type |
closeIdleTransactionPeriod - Int!
|
Auto-close idle transactions period in seconds for this connection type |
autoCloseConnections - Boolean!
|
Auto-close connections is enabled for this connection type |
closeIdleConnectionPeriod - Int!
|
Auto-close idle connections period in seconds for this connection type |
predefined - Boolean!
|
Specifies whether this connection type is system-defined or user-defined. System-defined connection types cannot be deleted. |
Example
{
"id": "<id>",
"name": "<string>",
"description": "<string>",
"colorLight": "<string>",
"colorDark": "<string>",
"autocommit": "<boolean>",
"confirmExecute": "<boolean>",
"confirmDataChange": "<boolean>",
"smartCommit": "<boolean>",
"smartCommitRecover": "<boolean>",
"autoCloseTransactions": "<boolean>",
"closeIdleTransactionPeriod": "<int>",
"autoCloseConnections": "<boolean>",
"closeIdleConnectionPeriod": "<int>",
"predefined": "<boolean>"
}
ConnectionTypeConfigInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Unique identifier of the connection type |
name - String!
|
Name of the connection type |
description - String
|
Description of the connection type |
colorLight - String!
|
Connection type color for the light theme |
colorDark - String
|
Connection type color for the dark theme |
autocommit - Boolean!
|
Whether auto-commit is enabled for this connection type |
confirmExecute - Boolean!
|
Whether query execution confirmation is enabled for this connection type |
confirmDataChange - Boolean!
|
Whether data change confirmation (INSERT, UPDATE, DELETE) is enabled for this connection type |
smartCommit - Boolean!
|
Whether smart commit mode is enabled for this connection type |
smartCommitRecover - Boolean!
|
Whether smart commit recovery is enabled for this connection type |
autoCloseTransactions - Boolean!
|
Whether automatic transaction closing is enabled for this connection type |
closeIdleTransactionPeriod - Int!
|
Idle transaction timeout in seconds for this connection type |
autoCloseConnections - Boolean!
|
Whether automatic connection closing is enabled for this connection type |
closeIdleConnectionPeriod - Int!
|
Idle connection timeout in seconds for this connection type |
Example
{
"id": "<id>",
"name": "<string>",
"description": "<string>",
"colorLight": "<string>",
"colorDark": "<string>",
"autocommit": "<boolean>",
"confirmExecute": "<boolean>",
"confirmDataChange": "<boolean>",
"smartCommit": "<boolean>",
"smartCommitRecover": "<boolean>",
"autoCloseTransactions": "<boolean>",
"closeIdleTransactionPeriod": "<int>",
"autoCloseConnections": "<boolean>",
"closeIdleConnectionPeriod": "<int>"
}
DatabaseAuthModel
Description
Drivers and connections
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Auth model unique ID |
displayName - String!
|
Display name of the auth model |
description - String
|
Description of the auth model |
icon - String
|
Path to the auth model icon |
requiresLocalConfiguration - Boolean
|
Checks if the auth model needs a configuration on a local file system |
requiredAuth - String
|
Returns id of the required auth provider if the auth model requires it |
properties - [ObjectPropertyInfo!]!
|
List of properties for the auth model that can be displayed in the UI |
Example
{
"id": "<id>",
"displayName": "<string>",
"description": "<string>",
"icon": "<string>",
"requiresLocalConfiguration": "<boolean>",
"requiredAuth": "<string>",
"properties": [ObjectPropertyInfo]
}
DateTime
Description
Date/Time
Example
"<datetime>"
DictionaryValueInfo
Description
Generic dictionary value: an identifier with a human readable name and an optional description
Example
{"id": "<id>", "name": "<string>", "description": "<string>"}
DimensionPricingInfo
DriverConfiguration
Description
Database-dependent metadata describing features supported by the driver
Fields
| Field Name | Description |
|---|---|
supportedInsertReplaceMethods - [DictionaryValueInfo!]!
|
Supported 'on duplicate key' replace methods for this connection's SQL dialect |
supportsBulkLoad - Boolean!
|
Whether the connection's database supports bulk load during data import |
supportsTransactions - Boolean!
|
Whether the connection's database supports transactions |
Example
{
"supportedInsertReplaceMethods": [DictionaryValueInfo],
"supportsBulkLoad": "<boolean>",
"supportsTransactions": "<boolean>"
}
DriverConfigurationType
Values
| Enum Value | Description |
|---|---|
|
|
Driver uses host, port, database and server name fields |
|
|
Driver uses URL field |
Example
"MANUAL"
DriverFileInfo
DriverInfo
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Driver unique full ID. It is providerId + "." + driverId. It is recommended to use providerId and driverId separately. |
name - String
|
Name of the driver |
description - String
|
Description of the driver |
icon - String
|
Path to the driver icon |
iconBig - String
|
Path to the driver icon for big size |
driverId - ID!
|
Driver ID. It is unique within provider |
providerId - ID!
|
Driver provider ID. It is globally unique |
driverClassName - String
|
Driver Java class name |
defaultHost - String
|
Default host for the driver |
defaultPort - String
|
Default port for the driver |
defaultDatabase - String
|
Default database name for the driver |
defaultServer - String
|
Default server name for the driver |
defaultUser - String
|
Default user name for the driver |
sampleURL - String
|
Default connection URL for the driver |
driverInfoURL - String
|
Returns link to the driver documentation page |
driverPropertiesURL - String
|
Returns link to the driver properties page |
embedded - Boolean
|
Defines if the database for this driver is embedded |
enabled - Boolean!
|
Defines if the driver is enabled |
requiresServerName - Boolean
|
Defines if the driver page requires server name field use mainProperties instead |
requiresDatabaseName - Boolean
|
Defines if the driver page requires database name field use mainProperties instead |
useCustomPage - Boolean!
|
Defines if host, port, database, server name fields are using a custom page |
licenseRequired - Boolean
|
Defines if driver license is required |
license - String
|
Driver license information |
custom - Boolean
|
Defines if the driver is a custom driver |
promotedScore - Int
|
Driver score for ordering, biggest first |
driverProperties - [ObjectPropertyInfo!]!
|
Driver properties. Note: it is expensive property and it may produce database server roundtrips. Call it only when you really need it. These properties are for advanced users in usually shouldn't be specified for new connections. |
driverParameters - Object!
|
Driver parameters (map name->value) |
mainProperties - [ObjectPropertyInfo!]!
|
Main driver properties. Contains info about main fields (host, port, database, server name) that are used in main connection page |
providerProperties - [ObjectPropertyInfo!]!
|
Additional driver provider properties. These properties can be configured by user on main connection page to provide important connection settings |
expertSettingsProperties - [ObjectPropertyInfo!]!
|
Expert driver settings properties. Returns properties (like keep-alive interval) that are not often used and can be hidden in UI |
anonymousAccess - Boolean
|
False for drivers which do not support authentication. |
defaultAuthModel - ID!
|
Default auth model that is used for this driver (see authModels) |
applicableAuthModels - [ID!]!
|
List of auth models that can be used with this driver (see authModels) |
applicableNetworkHandlers - [ID]!
|
List of network handlers that can be used with this driver (SSH/SSL) |
configurationTypes - [DriverConfigurationType]!
|
Configuration types are used in UI to determine how to display connection settings (show host/port/database fields or use URL field) |
downloadable - Boolean!
|
Defines if the driver can be downloaded remotely |
driverInstalled - Boolean!
|
Defines if the driver is installed on the server |
driverLibraries - [DriverLibraryInfo!]!
|
List of driver libraries that are used for connecting to the database |
safeEmbeddedDriver - Boolean!
|
Defines if embedded driver is safe to use in the server |
Example
{
"id": "<id>",
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"iconBig": "<string>",
"driverId": "<id>",
"providerId": "<id>",
"driverClassName": "<string>",
"defaultHost": "<string>",
"defaultPort": "<string>",
"defaultDatabase": "<string>",
"defaultServer": "<string>",
"defaultUser": "<string>",
"sampleURL": "<string>",
"driverInfoURL": "<string>",
"driverPropertiesURL": "<string>",
"embedded": "<boolean>",
"enabled": "<boolean>",
"requiresServerName": "<boolean>",
"requiresDatabaseName": "<boolean>",
"useCustomPage": "<boolean>",
"licenseRequired": "<boolean>",
"license": "<string>",
"custom": "<boolean>",
"promotedScore": "<int>",
"driverProperties": [ObjectPropertyInfo],
"driverParameters": "<object>",
"mainProperties": [ObjectPropertyInfo],
"providerProperties": [ObjectPropertyInfo],
"expertSettingsProperties": [ObjectPropertyInfo],
"anonymousAccess": "<boolean>",
"defaultAuthModel": "<id>",
"applicableAuthModels": ["<id>"],
"applicableNetworkHandlers": ["<id>"],
"configurationTypes": ["MANUAL"],
"downloadable": "<boolean>",
"driverInstalled": "<boolean>",
"driverLibraries": [DriverLibraryInfo],
"safeEmbeddedDriver": "<boolean>"
}
DriverLibraryInfo
Description
Driver library information. Used to display driver files in UI
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Driver library unique ID |
name - String!
|
Driver library name |
icon - String
|
Path to the driver library icon |
libraryFiles - [DriverFileInfo!]
|
List of files that are used by the driver |
Example
{
"id": "<id>",
"name": "<string>",
"icon": "<string>",
"libraryFiles": [DriverFileInfo]
}
ExternalParametersInfo
ExternalParametersInput
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
"<float>"
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>"
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>"
LogEntry
MarketplaceProductInfo
Fields
| Field Name | Description |
|---|---|
dimensionPricingInfo - [DimensionPricingInfo!]
|
Pricing information based on users usage |
Example
{"dimensionPricingInfo": [DimensionPricingInfo]}
NetworkEndpointInfo
NetworkHandlerAuthType
Description
SSH network handler authentication type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PASSWORD"
NetworkHandlerConfig
Description
SSH/SSL network handler config. Name without prefix only for backward compatibility
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
enabled - Boolean!
|
Defines if the network handler is enabled |
authType - NetworkHandlerAuthType!
|
SSH network handler auth type use properties |
userName - String
|
SSH network handler user name |
password - String
|
SSH network handler user password |
key - String
|
SSH network handler private key use secured properties |
savePassword - Boolean!
|
A flag that indicates if the password should be saved in the secure storage |
properties - Object!
|
Network handler properties (name/value) |
secureProperties - Object!
|
Network handler secure properties (name/value). Used for passwords and keys |
Example
{
"id": "<id>",
"enabled": "<boolean>",
"authType": "PASSWORD",
"userName": "<string>",
"password": "<string>",
"key": "<string>",
"savePassword": "<boolean>",
"properties": "<object>",
"secureProperties": "<object>"
}
NetworkHandlerConfigInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
enabled - Boolean
|
Defines if the network handler should be enabled |
userName - String
|
Sets user name for the network handler (SSH) |
password - String
|
Sets user password for the network handler (SSH) |
savePassword - Boolean
|
Sets a flag that indicates if the password should be saved in the secure storage |
properties - Object
|
Network handler properties (name/value) |
secureProperties - Object
|
Network handler secure properties (name/value). Used for passwords and keys |
Example
{
"id": "<id>",
"enabled": "<boolean>",
"userName": "<string>",
"password": "<string>",
"savePassword": "<boolean>",
"properties": "<object>",
"secureProperties": "<object>"
}
NetworkHandlerDescriptor
Description
Network handler descriptor. This descriptor is used to describe network handlers (SSH/SSL) that can be used for connections.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
codeName - String!
|
|
label - String!
|
|
description - String
|
|
secured - Boolean!
|
|
type - NetworkHandlerType
|
|
properties - [ObjectPropertyInfo!]!
|
Properties that can be displayed in the UI |
Example
{
"id": "<id>",
"codeName": "<string>",
"label": "<string>",
"description": "<string>",
"secured": "<boolean>",
"type": "TUNNEL",
"properties": [ObjectPropertyInfo]
}
NetworkHandlerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"TUNNEL"
Object
Description
Any object (JSON)
Example
"<object>"
ObjectOrigin
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 |
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) |
defaultValue - Object
|
Default 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>",
"hint": "<string>",
"category": "<string>",
"dataType": "<string>",
"value": "<object>",
"validValues": ["<object>"],
"defaultValue": "<object>",
"length": "TINY",
"features": ["<string>"],
"order": "<int>",
"supportedConfigurationTypes": ["<string>"],
"required": "<boolean>",
"scopes": ["<string>"],
"conditions": [Condition]
}
ObjectPropertyLength
Values
| Enum Value | Description |
|---|---|
|
|
1 character |
|
|
20 characters |
|
|
<= 64 characters |
|
|
Full line length. The default |
|
|
Multi-line long text |
Example
"TINY"
PasswordPolicyConfig
Description
Password policy configuration
Example
{
"minLength": "<int>",
"minNumberCount": "<int>",
"minSymbolCount": "<int>",
"requireMixedCase": "<boolean>"
}
ProductInfo
Description
Product information
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the product |
version - String!
|
The product version |
name - String!
|
The product name |
description - String
|
The product description |
buildTime - String!
|
The build timestamp of the product |
releaseTime - String!
|
The release timestamp of the product |
licenseInfo - String
|
Information about the product license |
latestVersionInfo - String
|
Information about the latest available version |
productPurchaseURL - String
|
URL for purchasing the product |
Example
{
"id": "<id>",
"version": "<string>",
"name": "<string>",
"description": "<string>",
"buildTime": "<string>",
"releaseTime": "<string>",
"licenseInfo": "<string>",
"latestVersionInfo": "<string>",
"productPurchaseURL": "<string>"
}
ProductSettings
Fields
| Field Name | Description |
|---|---|
groups - [ProductSettingsGroup!]!
|
|
settings - [ObjectPropertyInfo!]!
|
each property is associated with a group by category |
Example
{
"groups": [ProductSettingsGroup],
"settings": [ObjectPropertyInfo]
}
ProductSettingsGroup
ProjectInfo
Example
{
"id": "<string>",
"global": "<boolean>",
"shared": "<boolean>",
"name": "<string>",
"description": "<string>",
"canEditDataSources": "<boolean>",
"canViewDataSources": "<boolean>",
"canEditResources": "<boolean>",
"canViewResources": "<boolean>",
"resourceTypes": [RMResourceType]
}
RMResourceType
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
displayName - String!
|
|
icon - String
|
|
fileExtensions - [String!]!
|
|
rootFolder - String
|
Example
{
"id": "<string>",
"displayName": "<string>",
"icon": "<string>",
"fileExtensions": ["<string>"],
"rootFolder": "<string>"
}
ResultDataFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"resultset"
SecretInfo
ServerConfig
Description
Server configuration
Fields
| Field Name | Description |
|---|---|
serverURL - String!
|
No longer supported |
rootURI - String!
|
|
hostName - String!
|
use container id instead |
containerId - String!
|
|
defaultAuthRole - String
|
|
defaultUserTeam - String
|
|
sessionExpireTime - Int!
|
|
localHostAddress - String
|
|
redirectOnFederatedAuth - Boolean!
|
|
enabledAuthProviders - [ID!]!
|
|
passwordPolicyConfiguration - PasswordPolicyConfig!
|
|
forceHttps - Boolean!
|
Mark all cookies as secure, recommend for HTTPS deployment configurations |
supportedHosts - [String!]!
|
List of allowed hosts to use the application - if empty, all hosts are allowed |
bindSessionToIp - String!
|
Indicates whether the session should be linked to the user's IP address |
name - String!
|
Server name |
version - String!
|
Version of the server |
workspaceId - ID!
|
ID of the server workspace |
anonymousAccessEnabled - Boolean!
|
Defines if the anonymous access is enabled |
supportsCustomConnections - Boolean!
|
Defines if non-admin users can create connections |
resourceManagerEnabled - Boolean!
|
Defines if resource manager is enabled |
secretManagerEnabled - Boolean!
|
Defines if secret manager is enabled |
publicCredentialsSaveEnabled - Boolean!
|
Defines is it is possible to save user database credentials |
adminCredentialsSaveEnabled - Boolean!
|
Defines is it is possible to save global database credentials |
licenseRequired - Boolean!
|
Defines if the server requires a license |
licenseValid - Boolean!
|
Defines if the server license is valid |
licenseStatus - String
|
Returns information about the server license status |
configurationMode - Boolean!
|
Defines if the server is in configuration mode |
developmentMode - Boolean!
|
Defines if the server is in development mode |
distributed - Boolean!
|
Defines if the server is distributed |
enabledFeatures - [ID!]!
|
List of enabled features |
disabledBetaFeatures - [ID!]
|
List of disabled beta features |
serverFeatures - [ID!]
|
List of server features |
supportedLanguages - [ServerLanguage!]!
|
List of supported languages |
productConfiguration - Object!
|
Product configuration |
productInfo - ProductInfo!
|
Product information |
defaultNavigatorSettings - NavigatorSettings!
|
Navigator settings for the server |
disabledDrivers - [ID!]!
|
List of disabled drivers (IDs of DriverInfo) |
resourceQuotas - Object!
|
Resource quotas (e.g., max amount of running SQL queries) |
licenseUsersModificationEnabled - Boolean
|
Defines if the server can modify license users |
Example
{
"serverURL": "<string>",
"rootURI": "<string>",
"hostName": "<string>",
"containerId": "<string>",
"defaultAuthRole": "<string>",
"defaultUserTeam": "<string>",
"sessionExpireTime": "<int>",
"localHostAddress": "<string>",
"redirectOnFederatedAuth": "<boolean>",
"enabledAuthProviders": ["<id>"],
"passwordPolicyConfiguration": PasswordPolicyConfig,
"forceHttps": "<boolean>",
"supportedHosts": ["<string>"],
"bindSessionToIp": "<string>",
"name": "<string>",
"version": "<string>",
"workspaceId": "<id>",
"anonymousAccessEnabled": "<boolean>",
"supportsCustomConnections": "<boolean>",
"resourceManagerEnabled": "<boolean>",
"secretManagerEnabled": "<boolean>",
"publicCredentialsSaveEnabled": "<boolean>",
"adminCredentialsSaveEnabled": "<boolean>",
"licenseRequired": "<boolean>",
"licenseValid": "<boolean>",
"licenseStatus": "<string>",
"configurationMode": "<boolean>",
"developmentMode": "<boolean>",
"distributed": "<boolean>",
"enabledFeatures": ["<id>"],
"disabledBetaFeatures": ["<id>"],
"serverFeatures": ["<id>"],
"supportedLanguages": [ServerLanguage],
"productConfiguration": "<object>",
"productInfo": ProductInfo,
"defaultNavigatorSettings": NavigatorSettings,
"disabledDrivers": ["<id>"],
"resourceQuotas": "<object>",
"licenseUsersModificationEnabled": "<boolean>"
}
ServerError
Description
Various server errors descriptor
Fields
| Field Name | Description |
|---|---|
message - String
|
Error message text |
errorCode - String
|
Retrieves the vendor-specific error code |
errorType - String
|
Type/category of the error |
stackTrace - String
|
Stack trace for debugging |
causedBy - ServerError
|
Nested error that caused this error (recursive) |
Example
{
"message": "<string>",
"errorCode": "<string>",
"errorType": "<string>",
"stackTrace": "<string>",
"causedBy": ServerError
}
ServerLanguage
Description
Languages supported by server
Example
{"isoCode": "<string>", "displayName": "<string>", "nativeName": "<string>"}
SessionInfo
Fields
| Field Name | Description |
|---|---|
createTime - String!
|
The time when the session was created |
lastAccessTime - String!
|
The last time the session was accessed |
locale - String!
|
The current locale of the session |
cacheExpired - Boolean!
|
Indicates whether the session cache has expired |
connections - [ConnectionInfo!]!
|
List of active connections in the session |
actionParameters - Object
|
Action parameters for the session (e.g., opening a connection) |
valid - Boolean!
|
Indicates if the session is valid |
remainingTime - Int!
|
Remaining time before the session expires (in seconds) |
Example
{
"createTime": "<string>",
"lastAccessTime": "<string>",
"locale": "<string>",
"cacheExpired": "<boolean>",
"connections": [ConnectionInfo],
"actionParameters": "<object>",
"valid": "<boolean>",
"remainingTime": "<int>"
}
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>"