Keboola · Schema

WorkspaceDetailResponseWithSecret

Data PlatformETLELTData PipelinesData StorageTransformationsOrchestrationData OperationsCloud DataSnowflakeBigQuery

Properties

Name Type Description
id integer ID of the workspace.
type string Type of the workspace.
name string Name of the workspace (schema name for table type).
component string ID of the component that created the workspace.
configurationId string ID of the configuration that created the workspace.
configurationVersion integer Pinned configuration version.
created string Date and time of workspace creation.
connection object Connection details for the workspace.
backendSize string Size of the backend (e.g., for Snowflake).
statementTimeoutSeconds integer Statement timeout in seconds.
creatorToken object
readOnlyStorageAccess boolean Indicates if read-only storage access is enabled.
platformUsageType string Platform usage type.
View JSON Schema on GitHub

JSON Schema

keboola-workspacedetailresponsewithsecret.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WorkspaceDetailResponseWithSecret",
  "required": [
    "id",
    "type",
    "created",
    "connection",
    "statementTimeoutSeconds",
    "creatorToken",
    "readOnlyStorageAccess"
  ],
  "properties": {
    "id": {
      "description": "ID of the workspace.",
      "type": "integer"
    },
    "type": {
      "description": "Type of the workspace.",
      "type": "string",
      "enum": [
        "file",
        "table"
      ]
    },
    "name": {
      "description": "Name of the workspace (schema name for table type).",
      "type": "string",
      "nullable": true
    },
    "component": {
      "description": "ID of the component that created the workspace.",
      "type": "string",
      "nullable": true
    },
    "configurationId": {
      "description": "ID of the configuration that created the workspace.",
      "type": "string",
      "nullable": true
    },
    "configurationVersion": {
      "description": "Pinned configuration version.",
      "type": "integer",
      "nullable": true
    },
    "created": {
      "description": "Date and time of workspace creation.",
      "type": "string",
      "format": "date-time"
    },
    "connection": {
      "description": "Connection details for the workspace.",
      "type": "object",
      "oneOf": [
        {
          "required": [
            "backend",
            "host",
            "user",
            "loginType",
            "ssoLoginAvailable"
          ],
          "properties": {
            "backend": {
              "description": "Workspace backend type.",
              "type": "string",
              "enum": [
                "snowflake",
                "bigquery"
              ]
            },
            "region": {
              "description": "Region of the workspace backend.",
              "type": "string",
              "nullable": true
            },
            "host": {
              "description": "Hostname of the workspace backend.",
              "type": "string"
            },
            "database": {
              "description": "Database name (project name for Snowflake).",
              "type": "string",
              "nullable": true
            },
            "schema": {
              "description": "Schema name.",
              "type": "string",
              "nullable": true
            },
            "warehouse": {
              "description": "Warehouse name (for Snowflake).",
              "type": "string",
              "nullable": true
            },
            "user": {
              "description": "Username for connecting to the workspace. Empty when loginType is \"none\".",
              "type": "string"
            },
            "loginType": {
              "description": "Login type used for the connection. Value \"none\" means the workspace has no direct credentials and is intended for QueryService. Create direct connection credentials later using the workspace credentials endpoint.",
              "type": "string",
              "enum": [
                "default",
                "snowflake-legacy-service",
                "snowflake-person-sso",
                "snowflake-person-keypair",
                "snowflake-service-keypair",
                "none"
              ]
            },
            "ssoLoginAvailable": {
              "description": "Indicates if SSO login is available.",
              "type": "boolean"
            },
            "privateKey": {
              "description": "Private key for workspace user.",
              "type": "string",
              "nullable": true
            },
            "credentials": {
              "required": [
                "id"
              ],
              "properties": {
                "id": {
                  "description": "ID of the token that created the workspace.",
                  "type": "integer"
                },
                "private_key": {
                  "description": "Private key for workspace user.",
                  "type": "string",
                  "nullable": true
                },
                "password": {
                  "description": "password to workspace user.",
                  "type": "string",
                  "nullable": true
                }
              },
              "type": "object"
            }
          }
        },
        {
          "required": [
            "backend"
          ],
          "properties": {
            "backend": {
              "description": "File storage backend type (e.g., azure, aws).",
              "type": "string"
            },
            "container": {
              "description": "Container name for file storage.",
              "type": "string",
              "nullable": true
            },
            "region": {
              "description": "Region of the file storage.",
              "type": "string",
              "nullable": true
            }
          }
        }
      ]
    },
    "backendSize": {
      "description": "Size of the backend (e.g., for Snowflake).",
      "type": "string",
      "nullable": true
    },
    "statementTimeoutSeconds": {
      "description": "Statement timeout in seconds.",
      "type": "integer"
    },
    "creatorToken": {
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "description": "ID of the token that created the workspace.",
          "type": "integer"
        },
        "description": {
          "description": "Description of the token.",
          "type": "string",
          "nullable": true
        }
      },
      "type": "object"
    },
    "readOnlyStorageAccess": {
      "description": "Indicates if read-only storage access is enabled.",
      "type": "boolean"
    },
    "platformUsageType": {
      "description": "Platform usage type.",
      "type": "string",
      "nullable": true
    }
  },
  "type": "object"
}