KEkeboola
Workspaces

List workspaces

Returns all workspaces for the project in the given branch. Use default as branchId (or the variant without the branch prefix) to list workspaces of the default branch.

get/v2/storage/branch/{branchId}/workspaces

Request

Path parameters

branchIdstring required

Response

List of workspaces.

idinteger required

ID of the workspace.

type'file' | 'table' required

Type of the workspace.

namestring nullable required

Name of the workspace (schema name for table type).

componentstring nullable required

ID of the component that created the workspace.

configurationIdstring nullable required

ID of the configuration that created the workspace.

configurationVersioninteger nullable required

Pinned configuration version.

createdstring required

Date and time of workspace creation, ISO 8601 with a +hhmm offset.

backendSizestring nullable required

Size of the backend (e.g., for Snowflake).

statementTimeoutSecondsinteger required

Statement timeout in seconds.

readOnlyStorageAccessboolean required

Indicates if read-only storage access is enabled.

platformUsageType'service' | 'user' | 'reader' nullable required

Platform usage type.

state'active' | 'deactivated' required

Lifecycle state of the workspace. A deactivated workspace is kept listed so its owner can delete it, but its backend identity is disabled and cannot be connected to; contact support to reactivate it.

lastActivityAtstring nullable required

Last observed workspace use (backend login or Storage job), ISO 8601 with a +hhmm offset. May be a seeded floor for an unused workspace; null when unknown.

warnAtstring nullable required

Projected date retention would warn this workspace, ISO 8601 with a +hhmm offset. It can move when the workspace is used; null when retention does not apply or activity has not been synced recently.

deactivateAtstring nullable required

When retention will deactivate this unused workspace, ISO 8601 with a +hhmm offset. Null unless the owner has been warned. Connecting to the workspace cancels it. Can lie in the past while retention only notifies.

deleteAtstring nullable required

When retention will delete this deactivated workspace, ISO 8601 with a +hhmm offset. Null unless the workspace is deactivated. Support can reactivate it until then.

Example response

[
  {
    "created": "2017-02-13T12:01:05+0100",
    "lastActivityAt": "2017-02-13T12:01:05+0100",
    "warnAt": "2017-02-13T12:01:05+0100",
    "deactivateAt": "2017-02-13T12:01:05+0100",
    "deleteAt": "2017-02-13T12:01:05+0100"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.