Sign in

v34

OpenAPI 3.1.0raw.githubusercontent.com2026-07-130042.4 KB
workspaces

Get a Workspace

Get the specified Workspace.

get/v1/organizations/{organizationId}/workspaces/{workspaceId}

Path parameters

organizationIdstring required

The <code>id</code> of the Organization that contains the Workspace.

workspaceIdstring required

The <code>id</code> of the Workspace to get.

Response

The Workspace details have been retrieved

workspaceIdstring required

Unique identifier for the Workspace.

region'us-west-2' | 'us-east-1' | 'us-east-2' | 'eu-central-1' | 'eu-central-2' | 'eu-west-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ca-central-1' | 'ap-northeast-1' | 'sa-east-1' | 'eu-west-1' | 'eu-west-3' required

AWS region where the Workspace is deployed.

leaderFQDNstring required

Fully Qualified Domain Name (FQDN) of the Workspace Leader.

state'Provisioning' | 'Active' | 'Inactive' | 'Failed' | 'Deprovisioning' required

Current state of the Workspace.

aliasstring

User-friendly alias for the Workspace.

descriptionstring

Brief description of the Workspace.

tagsstring[]

Tags associated with the Workspace.

Example response

{
  "workspaceId": "main",
  "leaderFQDN": "workspace-leader.example.com",
  "alias": "Production Environment",
  "description": "Main production Workspace for customer data processing",
  "tags": [
    "production",
    "customer-data"
  ]
}