SCscalr
workspaces

Get a Workspace

Changed on

Show details of a specific workspace.

get/workspaces/{workspace}

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/workspaces/{workspace}
  • Auth
    HTTP bearer

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.

includedobject[]
metaobject

Changes

  • d3e1dc85657aRevision changes
    • warning

      added the new 30.00 enum value to the // response property for the response status

    • warning

      added the new 60.00 enum value to the // response property for the response status

    • warning

      added the new 90.00 enum value to the // response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value false was added for the status