Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Runners Workspaces

Create a new workspace

Creates a new workspace with the provided configuration

post/runners/workspaces

Request body

runnerTypestring required

Type of runner (e.g., firefly_runners)

iacTypestring required

Infrastructure as Code type

workspaceNamestring required

Unique workspace name

descriptionstring

Workspace description

labelsstring[]

Labels assigned to the workspace

vcsIdstring required

VCS integration ID

repostring required

Repository name

defaultBranchstring required

Default branch

vcsTypestring required

VCS type (github, gitlab, etc.)

workDirstring required

Working directory path

consumedVariableSetsstring[]

Array of variable set IDs that this workspace consumes

projectstring nullable

Project ID or null for global access

terraformVariablesobject

Cleaned by deleteMockArrays

terraformSensitiveVariablesobject

Cleaned by deleteMockArrays

providersCredentialsobject

Cleaned by deleteMockArrays

runnerEnvironmentobject

Cleaned by deleteMockArrays

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 request

{
  "runnerType": "firefly_runners",
  "iacType": "terraform",
  "workspaceName": "my-workspace",
  "description": "Production environment workspace",
  "labels": [
    "production",
    "terraform"
  ],
  "vcsId": "5fd126f5744410407fbc552f",
  "repo": "infralight/appiac",
  "defaultBranch": "main",
  "vcsType": "github",
  "workDir": "terraform/production",
  "consumedVariableSets": [
    "var-set-1",
    "var-set-2"
  ],
  "execution": {
    "triggers": [
      "merge"
    ],
    "applyRule": "manual",
    "terraformVersion": "1.5.7"
  },
  "poolId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Workspace created 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"
}