Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Runners Workspaces

Update a workspace

Updates an existing workspace with the provided configuration

patch/runners/workspaces/{workspaceId}

Path parameters

workspaceIdstring required

Unique identifier of the workspace

Request body

namestring

Workspace name

descriptionstring

Workspace description

labelsstring[]

Labels assigned to the workspace

vcsIntegrationIdstring

VCS integration ID

repositorystring

Repository name

defaultBranchstring

Default branch

vcsstring

VCS type (github, gitlab, etc.)

workingDirectorystring

Working directory path

runnerTypestring

Type of runner (e.g., firefly_runners)

cronExecutionPatternstring

Cron pattern for scheduled executions

parentIdstring nullable

Project ID or null for global access

poolIdstring

ID of the runner pool associated with the workspace

oidcAuthenticationboolean nullable

OIDC authentication setting. If null, inherits from parent project.

Example request

{
  "name": "my-workspace",
  "description": "Production environment workspace",
  "labels": [
    "production",
    "terraform"
  ],
  "vcsIntegrationId": "5fd126f5744410407fbc552f",
  "repository": "infralight/appiac",
  "defaultBranch": "main",
  "vcs": "github",
  "workingDirectory": "terraform/production",
  "runnerType": "firefly_runners",
  "triggerConfig": {
    "runOnPullRequest": true
  },
  "cronExecutionPattern": "0 2 * * *",
  "poolId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Workspace updated successfully

idstring

Unique identifier for the workspace

namestring required

Name of the workspace

descriptionstring

Description of the workspace

accountIdstring

ID of the account the workspace belongs to

repositorystring required

Repository URL for the workspace

workingDirectorystring

Working directory within the repository

vcsIntegrationIdstring required

ID of the VCS integration

vcsstring required

VCS type (e.g., github, gitlab)

defaultBranchstring required

Default branch for the workspace

cronExecutionPatternstring

Cron pattern for scheduled executions

labelsstring[]

Labels assigned to the workspace

poolIdstring

ID of the runner pool associated with the workspace

oidcAuthenticationboolean nullable

OIDC authentication setting. If null, inherits from parent project.

isRemoteboolean

Whether this workspace uses the internal remote backend for state management

Example response

{
  "poolId": "123e4567-e89b-12d3-a456-426614174000"
}