get_workspace_details
Retrieve detailed workspace information by ID or organization and workspace name. Useful for checking settings, configurations, and status in Terraform Cloud environments.
Instructions
Get details for a specific workspace, identified either by ID or by org name and workspace name.
Retrieves comprehensive information about a workspace including its configuration, VCS settings, execution mode, and other attributes. This is useful for checking workspace settings before operations or determining the current state of a workspace.
The workspace can be identified either by its ID directly, or by the combination of organization name and workspace name.
API endpoint:
- GET /workspaces/{workspace_id} (when using workspace_id)
- GET /organizations/{organization}/workspaces/{workspace_name} (when using org+name)
Args: workspace_id: The ID of the workspace (format: "ws-xxxxxxxx") organization: The name of the organization (required if workspace_id not provided) workspace_name: The name of the workspace (required if workspace_id not provided)
Returns: Comprehensive workspace details including settings, configuration and status
See: docs/tools/workspace.md for reference documentation
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| organization | No | ||
| workspace_id | No | ||
| workspace_name | No |