Git admin queries schema

service.git.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

gitGetGlobalSettings

Description

Returns the global git configuration settings. Null if git is not configured.

Response

Returns a GitGlobalSettings

Example

Query
query gitGetGlobalSettings {
  gitGetGlobalSettings {
    username
    email
    password
  }
}
Response
{
  "data": {
    "gitGetGlobalSettings": {
      "username": "<string>",
      "email": "<string>",
      "password": "<string>"
    }
  }
}
Queries

gitGetProjectSettings

Description

Returns the git configuration settings for a specific project. Null if git is not configured for the project.

Response

Returns a GitProjectSettings

Arguments
Name Description
projectId - ID!

Example

Query
query gitGetProjectSettings($projectId: ID!) {
  gitGetProjectSettings(projectId: $projectId) {
    enabled
    repositoryUrl
    branch
    gitIgnoreRules
  }
}
Variables
{"projectId": "<id>"}
Response
{
  "data": {
    "gitGetProjectSettings": {
      "enabled": "<boolean>",
      "repositoryUrl": "<string>",
      "branch": "<string>",
      "gitIgnoreRules": ["DATASOURCES"]
    }
  }
}

Mutations

gitSaveGlobalSettings

Description

Saves the global git configuration settings.

Response

Returns a GitGlobalSettings!

Arguments
Name Description
settings - GitGlobalSettingsInput!

Example

Query
mutation gitSaveGlobalSettings($settings: GitGlobalSettingsInput!) {
  gitSaveGlobalSettings(settings: $settings) {
    username
    email
    password
  }
}
Variables
{"settings": GitGlobalSettingsInput}
Response
{
  "data": {
    "gitSaveGlobalSettings": {
      "username": "<string>",
      "email": "<string>",
      "password": "<string>"
    }
  }
}
Mutations

gitSaveProjectSettings

Description

Saves the git configuration settings for a specific project.

Response

Returns a GitProjectSettings!

Arguments
Name Description
projectId - ID!
settings - GitProjectSettingsInput!

Example

Query
mutation gitSaveProjectSettings(
  $projectId: ID!,
  $settings: GitProjectSettingsInput!
) {
  gitSaveProjectSettings(
    projectId: $projectId,
    settings: $settings
  ) {
    enabled
    repositoryUrl
    branch
    gitIgnoreRules
  }
}
Variables
{"projectId": "<id>", "settings": GitProjectSettingsInput}
Response
{
  "data": {
    "gitSaveProjectSettings": {
      "enabled": "<boolean>",
      "repositoryUrl": "<string>",
      "branch": "<string>",
      "gitIgnoreRules": ["DATASOURCES"]
    }
  }
}
Mutations

gitTestRemoteRepositoryAccess

Description

Tests the global git configuration settings.

Response

Returns a Boolean!

Arguments
Name Description
settings - GitGlobalSettingsTestInput
repositoryUrl - String!

Example

Query
mutation gitTestRemoteRepositoryAccess(
  $settings: GitGlobalSettingsTestInput,
  $repositoryUrl: String!
) {
  gitTestRemoteRepositoryAccess(
    settings: $settings,
    repositoryUrl: $repositoryUrl
  )
}
Variables
{
  "settings": GitGlobalSettingsTestInput,
  "repositoryUrl": "<string>"
}
Response
{
  "data": {
    "gitTestRemoteRepositoryAccess": "<boolean>"
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

GitGlobalSettings

Description

Information about the global git configuration settings.

Fields
Field Name Description
username - String! Username for the git configuration.
email - String Email associated with the git configuration.
password - String! Password for the git configuration.
Example
{"username": "<string>", "email": "<string>", "password": "<string>"}
Types

GitGlobalSettingsInput

Description

Input for saving global git configuration settings.

Fields
Input Field Description
username - String! Username for the git configuration.
email - String Email associated with the git configuration.
password - String! Password for the git configuration.
Example
{"username": "<string>", "email": "<string>", "password": "<string>"}
Types

GitGlobalSettingsTestInput

Description

Input for testing git global settings.

Fields
Input Field Description
username - String Username for the git configuration.
email - String Email associated with the git configuration.
password - String Password for the git configuration.
Example
{"username": "<string>", "email": "<string>", "password": "<string>"}
Types

GitIgnoreRule

Description

Enum representing the different git ignore rules that can be applied to a project.

Values
Enum Value Description

DATASOURCES

DATASOURCE_CREDENTIALS

TASKS

PROJECT_METADATA

PROJECT_SETTINGS

BOOKMARKS

DATASETS

DIAGRAMS

SCRIPTS
Example
"DATASOURCES"
Types

GitProjectSettings

Description

Information about the git configuration settings for a specific project.

Fields
Field Name Description
enabled - Boolean! Indicates if git is enabled for the project.
repositoryUrl - String URL of the git repository for the project.
branch - String Branch of the git repository to use for the project.
gitIgnoreRules - [GitIgnoreRule!]! List of git ignore rules for the project.
Example
{
  "enabled": "<boolean>",
  "repositoryUrl": "<string>",
  "branch": "<string>",
  "gitIgnoreRules": ["DATASOURCES"]
}
Types

GitProjectSettingsInput

Description

Input for saving git configuration settings for a specific project.

Fields
Input Field Description
enabled - Boolean! Enables or disables git for the project.
repositoryUrl - String! URL of the git repository for the project.
branch - String Branch of the git repository to use for the project.
gitIgnoreRules - [GitIgnoreRule!] List of git ignore rules for the project.
Example
{
  "enabled": "<boolean>",
  "repositoryUrl": "<string>",
  "branch": "<string>",
  "gitIgnoreRules": ["DATASOURCES"]
}
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

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