Skip to main content
logoTetrate Service BridgeVersion: 1.9.x

Workspace Service

Service to manage TSB workspaces.

Workspaces

The Workspaces service provides methods to manage the workspaces for a given tenant.

Workspaces are the main containers for the different configuration resources available in TSB, and provide infrastructure isolation constraints.

CreateWorkspace

GetWorkspace

UpdateWorkspace

ListWorkspaces

DeleteWorkspace

CreateSettings

GetSettings

UpdateSettings

ListSettings

DeleteSettings

CreateWorkspaceRequest

Request to create a Workspace.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Workspace will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

workspace

tetrateio.api.tsb.v2.Workspace
REQUIRED
Details of the Workspace to be created.

message = {
  required: true
}

CreateWorkspaceSettingsRequest

Request to create a Workspace Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Workspace Settings will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

settings

tetrateio.api.tsb.v2.WorkspaceSetting
REQUIRED
Details of the Workspace Settings to be created.

message = {
  required: true
}

DeleteWorkspaceRequest

Request to delete a Workspace.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace.

string = {
  min_len: 1
}

force

bool
Force the deletion of the object even if deletion protection is enabled. If this is set, then the object and all its children will be deleted even if any of them has the deletion protection enabled.

DeleteWorkspaceSettingsRequest

Request to delete a Workspace Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace Settings.

string = {
  min_len: 1
}

GetWorkspaceRequest

Request to retrieve a Workspace.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace.

string = {
  min_len: 1
}

GetWorkspaceSettingsRequest

Request to retrieve a Workspace Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Workspace Settings.

string = {
  min_len: 1
}

ListWorkspaceSettingsRequest

Request to list Workspace Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Workspace Settings from.

string = {
  min_len: 1
}

ListWorkspaceSettingsResponse

The existing settings objects for the given workspace.

FieldDescriptionValidation Rule

settings

List of tetrateio.api.tsb.v2.WorkspaceSetting

ListWorkspacesRequest

Request to list Workspaces.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Workspaces from.

string = {
  min_len: 1
}

ListWorkspacesResponse

The existing workspaces for the given tenant.

FieldDescriptionValidation Rule

workspaces

List of tetrateio.api.tsb.v2.Workspace