---
title: "List all existing workspaces for the given tenant."
method: GET
path: "/v2/organizations/{organization}/tenants/{tenant}/workspaces"
tags: ["Workspaces"]
---

# List all existing workspaces for the given tenant.

`GET /v2/organizations/{organization}/tenants/{tenant}/workspaces`

## Request

- Base URL: `https://docs.tetrate.io` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.tetrate.io/v2/organizations/{organization}/tenants/{tenant}/workspaces`
- Auth: none declared
- TypeScript: <https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/docs/v2/organizations/:organization/tenants/:tenant/workspaces/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `organization` string, required
- `tenant` string, required

## Response `200`

A successful response.

- V2ListWorkspacesResponse: The existing workspaces for the given tenant.
  - `workspaces` V2Workspace[]
    - `fqn` string
    - `displayName` string
    - `etag` string
    - `description` string
    - `namespaceSelector` Typesv2NamespaceSelector, required
      - `names` string[], required: - `*/ns1` implies `ns1` namespace in any cluster. - `c1/ns1` implies `ns1` namespace from `c1` cluster. - `c1/*` implies all namespaces in `c1` cluster. - `*/*` implies all namespaces in all clusters. - `c1/ns*` implies all namespaces prefixes by `ns` in `c1` cluster.
    - `privileged` boolean: If set to true, allows Gateways in the workspace to route to services in other workspaces. Set this to true for workspaces owning cluster-wide gateways shared by multiple teams.
    - `isolationBoundary` string: Istio Isolation Boundary name to which this workspace belongs. If not provided explicitly, the workspace looks for an isolation boundary with name set as "global". Therefore, in order to move existing workspaces to isolation boundaries, and be a part of revisioned control plane, it is recommended to configure an isolation boundary with the name "global".
    - `securityDomain` string: Security domains can be used to group different resources under the same security domain. Although security domain is not resource itself currently, it follows a fqn format `organizations/myorg/securitydomains/mysecuritydomain`, and a child cannot override any ancestor's security domain. Once a security domain is assigned to a _Workspace_, all the children resources will belong to that security domain in the same way a _Security group_ belongs to a _Workspace_, a _Security group_ will also belong to the security domain assigned to the _Workspace_. Security domains can also be used to define _Security settings Authorization rules_ in which you can allow or deny request from or to a security domain.
    - `deletionProtectionEnabled` boolean: When set, prevents the resource from being deleted. In order to delete the resource this property needs to be set to `false` first.
    - `configGenerationMetadata` V2ConfigGenerationMetadata: `ConfigGenerationMetadata` allows to setup extra metadata that will be added in the final Istio generated configurations. Like new labels or annotations. Defining the config generation metadata in tenancy resources (like organization, tenant, workspace or groups) works as default values for those configs that belong to it. Defining same config generation metadata in configuration resources (like ingress gateways, service routes, etc.) will replace the ones defined in the tenancy resources.
      - `labels` object: Set of key value paris that will be added into the `metadata.labels` field of the Istio generated configurations.
      - `annotations` object: Set of key value paris that will be added into the `metadata.annotations` field of the Istio generated configurations.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api.md) - [All operations](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/revisions/2f19c3a1ae57?raw)