v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB

workspaces

Get a Workspace

Show details of a specific workspace.

get/workspaces/{workspace}

Path parameters

workspacestring required

The workspace ID to show.

Query parameters

includestring[]

The comma-separated list of relationship paths.

agent-poolsstring

The comma-separated list of fields to return in response for AgentPool resource.

configuration-versionsstring

The comma-separated list of fields to return in response for ConfigurationVersion resource.

container-image-versionsstring

The comma-separated list of fields to return in response for ContainerImageVersion resource.

drift-reportsstring

The comma-separated list of fields to return in response for DriftReport resource.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

module-versionsstring

The comma-separated list of fields to return in response for ModuleVersion resource.

modulesstring

The comma-separated list of fields to return in response for Module resource.

runsstring

The comma-separated list of fields to return in response for Run resource.

tagsstring

The comma-separated list of fields to return in response for Tag resource.

usersstring

The comma-separated list of fields to return in response for User resource.

vcs-providersstring

The comma-separated list of fields to return in response for VcsProvider resource.

workspace-readmestring

The comma-separated list of fields to return in response for WorkspaceReadme resource.

workspacesstring

The comma-separated list of fields to return in response for Workspace resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Response

Success.