Sign in
workspaces

List Workspaces

get/workspaces

Request

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

Query parameters

filter[environment]string

The ID of the Environment

filter[workspace]string

The ID(s) of the Workspace.

filter[account]string

The ID of the Account

filter[created-by]string

The ID of the User who created this workspace

filter[name]string

Workspace name

filter[environment-type]string

Workspace environment type

filter[run][status]string

Last run status

filter[run][created-by]string

Last run created by filter

filter[agent-pool]string

The ID(s) of the Agent Pool.

filter[software-version]string

The ID of the Software Version

filter[provider-configuration]string

The ID of the Provider configuration.

filter[var-set]string

Filter by variable set ID(s) applied to the workspace.

filter[vcs-provider]string

The ID of the VCS provider

filter[federated-to-env]string

The ID of the Environment that got access to workspaces through federation.

filter[federated-by-env]string

The ID of the Environment that gives access to workspaces through federation.

filter[vcs-repo][identifier]string

Filter by VCS repository

filter[state-consumer-of]string

Filter by remote state consumer source Workspace ID.

page[number]string

Page number

page[size]string

Page size

querystring

Query string, search by id, name.

filter[updated-at]string

Date of workspace modification.

filter[deletion-protection-enabled]string

Deletion protection enabled filter

filter[has-resources]string

Has resources filter

filter[updated-by]string

The ID of the User who update this workspace

filter[tag]string

Filter workspaces by tags

filter[run][resource-drifts]string

Filter the workspaces by last run drifted resources count.

filter[favorite]string

Filter workspaces by favorite status. Set to 'true' to show only favorites, 'false' to exclude favorites.

filter[environment][name]string

The name of the Environment

sort[favorite-first]string

When set to 'true', favorite workspaces are shown first, followed by non-favorites. Both groups respect the main sort order.

filter[drift-detection-enabled]boolean

Is drift detection enabled

filter[drift-detected]boolean

Filter workspaces by detected drift. Set to 'true' to show only workspaces with drift awaiting a manual action, 'false' to exclude them.

includestring[]

The comma-separated list of relationship paths.

sortstring[]

The comma-separated list of attributes.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.