Workflows

Workspaces

List Workspaces

post

Lists all Workspaces with Filtering and Sorting Options. Supports VCS Providers Integration.

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

pageintegerOptionalDefault: 0

pageSizeinteger · min: 1OptionalDefault: 25

Body

application/json

projectionstring[]Optional

Fields to include in the response

searchValuestringOptional

Value to search for across searchable fields

Responses

200

List of Workspaces Retrieved Successfully

application/json

Base entity with common fields

idstringOptional

Unique identifier

Example: 507f1f77bcf86cd799439011Pattern: ^[0-9a-fA-F]{24}$

accountIdstringOptional

Account ID

Example: 507f1f77bcf86cd799439011

createdAtstring · date-timeOptional

Timestamp when the workspace was created

updatedAtstring · date-timeOptional

Timestamp when the workspace was last updated

workspaceIdstringOptional

Workspace ID

Example: 507f1f77bcf86cd799439012

workspaceNamestringOptional

Name of the workspace

Example: production-infra

repostringOptional

Repository name

Example: org/repo-name

repoUrlstringOptional

Repository URL

Example: https://github.com/org/repo-name

vcsTypestring · enumOptional

The type of version control system

Example: githubPossible values:

runnerTypestring · enumOptional

The type of CI/CD runner or pipeline system

Example: github-actionsPossible values:

lastRunStatusstring · enumOptional

The status of a workspace run

Example: plan_successPossible values:

lastApplyTimestring · date-timeOptional

Timestamp of the last apply

lastPlanTimestring · date-timeOptional

Timestamp of the last plan

lastRunTimestring · date-timeOptional

Timestamp of the last run

iacTypestringOptional

Type of Infrastructure as Code

Example: terraform

iacTypeVersionstringOptional

Version of the IaC tool

Example: 1.0.11

labelsstring[]Optional

Labels associated with the workspace

Example: ["prod","terraform"]

poolIdstring · uuidOptional

UUID of the runner pool associated with the workspace

Example: 123e4567-e89b-12d3-a456-426614174000

runsCountintegerOptional

Number of runs

Example: 5

isWorkflowManagedbooleanOptional

Whether the workflow is managed by the system

Example: true

guardrailsstring[]Optional

List of guardrails

Example: ["cost","security"]

oidcAuthenticationboolean · nullableOptional

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

isRemotebooleanOptional

Whether this workspace uses the internal remote backend for state management

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/workspaces/search

HTTPcURLJavaScriptPython

POST /workspaces/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 734

{
  "projection": [
    "text"
  ],
  "searchValue": "text",
  "filters": {
    "workspaceName": [
      "production-infra"
    ],
    "repositories": [
      "org/repo-name"
    ],
    "ciTool": [
      "github-actions"
    ],
    "labels": [
      "text"
    ],
    "status": [
      "plan_success"
    ],
    "isManagedWorkflow": true,
    "vcsType": [
      "github"
    ],
    "poolId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "$or": {
      "workspaceName": [
        "production-infra"
      ],
      "repositories": [
        "org/repo-name"
      ],
      "ciTool": [
        "github-actions"
      ],
      "labels": [
        "text"
      ],
      "status": [
        "plan_success"
      ],
      "isManagedWorkflow": true,
      "vcsType": [
        "github"
      ],
      "poolId": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  },
  "sort": {
    "lastRunTime": {
      "order": -1
    },
    "workspaceName": {
      "order": -1
    },
    "repository": {
      "order": -1
    },
    "terraformVersion": {
      "order": -1
    },
    "lastRunStatus": {
      "order": -1
    },
    "ciTool": {
      "order": -1
    },
    "runs": {
      "order": -1
    }
  }
}

[
  {
    "id": "507f1f77bcf86cd799439011",
    "accountId": "507f1f77bcf86cd799439011",
    "createdAt": "2026-03-23T16:19:10.958Z",
    "updatedAt": "2026-03-23T16:19:10.958Z",
    "workspaceId": "507f1f77bcf86cd799439012",
    "workspaceName": "production-infra",
    "repo": "org/repo-name",
    "repoUrl": "https://github.com/org/repo-name",
    "vcsType": "github",
    "runnerType": "github-actions",
    "lastRunStatus": "plan_success",
    "lastApplyTime": "2026-03-23T16:19:10.958Z",
    "lastPlanTime": "2026-03-23T16:19:10.958Z",
    "lastRunTime": "2026-03-23T16:19:10.958Z",
    "iacType": "terraform",
    "iacTypeVersion": "1.0.11",
    "backendSummary": {
      "backendType": "s3",
      "backendConfig": {
        "bucket": "terraform-state",
        "key": "prod/terraform.tfstate"
      },
      "iacStackId": "stack-123",
      "managedResourceCount": 42
    },
    "labels": [
      "prod",
      "terraform"
    ],
    "poolId": "123e4567-e89b-12d3-a456-426614174000",
    "runsCount": 5,
    "isWorkflowManaged": true,
    "guardrails": [
      "cost",
      "security"
    ],
    "oidcAuthentication": true,
    "isRemote": true
  }
]

Delete a workspace

delete

Deletes a specific workspace and its associated data

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Responses

200

Workspace deleted successfully

application/json

statusinteger · enumRequiredPossible values:

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

delete

/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "data": {
    "message": "Workspace deleted successfully"
  }
}

Update Workspace Labels

put

Updates Labels for a specific Workspace

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json

labelsstring[]Required

List of labels to assign to the workspace

Responses

200

Workspace Labels Updated Successfully

application/json

idstringRequiredExample: 507f1f77bcf86cd799439015Pattern: ^[0-9a-fA-F]{24}$

workspaceNamestringRequiredExample: production-infra

labelsstring[]RequiredExample: ["production","terraform","critical"]

updatedAtstring · date-timeRequired

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

put

/workspaces/{workspaceId}/labels

HTTPcURLJavaScriptPython

PUT /workspaces/{workspaceId}/labels HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "labels": [
    "text"
  ]
}

{
  "id": "507f1f77bcf86cd799439015",
  "workspaceName": "production-infra",
  "labels": [
    "production",
    "terraform",
    "critical"
  ],
  "updatedAt": "2026-03-23T16:19:10.958Z"
}

List Workspace Runs

post

Lists all Runs for a specific Workspace

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query parameters

pageintegerOptionalDefault: 0

pageSizeinteger · min: 1OptionalDefault: 25

Body

application/json

projectionstring[]Optional

Fields to include in the response

searchValuestringOptional

Value to search for across searchable fields

Responses

200

List of Workspace Runs Retrieved Successfully

application/json

Base entity with common fields

idstringOptional

Unique identifier

Example: 507f1f77bcf86cd799439011Pattern: ^[0-9a-fA-F]{24}$

accountIdstringOptional

Unique identifier of the account

Example: 507f1f77bcf86cd799439011Pattern: ^[0-9a-fA-F]{24}$

createdAtstring · date-timeOptional

Timestamp when the entity was created

updatedAtstring · date-timeOptional

Timestamp when the entity was last updated

workspaceIdstringOptional

Unique identifier of the associated workspace

Example: 507f1f77bcf86cd799439012

workspaceNamestringOptional

Name of the workspace

Example: production-infra

runIdstringOptional

Unique identifier for the run

Example: run-123456

runNamestringOptional

Name of the run

Example: Deploy to Production

statusstring · enumOptional

The status of a workspace run

Example: plan_successPossible values:

pullRequestIdstringOptional

ID of the associated pull request

Example: 123

pullRequestUrlstringOptional

URL of the associated pull request

Example: https://github.com/org/repo/pull/123

branchstringOptional

Branch associated with the run

Example: main

commitIdstringOptional

ID of the commit

Example: abc123def456

commitUrlstringOptional

URL of the commit

Example: https://github.com/org/repo/commit/abc123def456

runnerTypestring · enumOptional

The type of CI/CD runner or pipeline system

Example: github-actionsPossible values:

buildIdstringOptional

ID of the build

Example: build-789012

buildUrlstringOptional

URL of the build

Example: https://github.com/org/repo/actions/runs/789012

buildNamestringOptional

Name of the build

Example: CI Build

vcsTypestring · enumOptional

The type of version control system

Example: githubPossible values:

repostringOptional

Repository associated with the run

Example: org/repo

repoUrlstringOptional

URL of the repository

Example: https://github.com/org/repo

titlestringOptional

Title of the run

Example: Update infrastructure for new feature

terraformVersionstringOptional

Version of Terraform used

Example: 1.0.11

iacTypestring · enumOptional

Type of Infrastructure as Code

Example: terraformPossible values:

planTaskIdstringOptional

Unique identifier of the plan task

Example: 507f1f77bcf86cd799439013Pattern: ^[0-9a-fA-F]{24}$

applyTaskIdstringOptional

Unique identifier of the apply task

Example: 507f1f77bcf86cd799439014Pattern: ^[0-9a-fA-F]{24}$

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/workspaces/{workspaceId}/runs/search

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/runs/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1366

{
  "projection": [
    "text"
  ],
  "searchValue": "text",
  "filters": {
    "runId": [
      "run-123456"
    ],
    "runName": [
      "Deploy to Production"
    ],
    "status": [
      "plan_success"
    ],
    "pullRequestUrl": [
      "https://github.com/org/repo/pull/123"
    ],
    "branch": [
      "main"
    ],
    "commitId": [
      "abc123def456"
    ],
    "ciTool": [
      "github-actions"
    ],
    "buildId": [
      "build-789012"
    ],
    "buildName": [
      "CI Build"
    ],
    "buildUrl": [
      "https://github.com/org/repo/actions/runs/789012"
    ],
    "vcsType": [
      "github"
    ],
    "repository": [
      "org/repo"
    ],
    "repositoryUrl": [
      "https://github.com/org/repo"
    ],
    "title": [
      "Update infrastructure for new feature"
    ],
    "createdAt": "2026-03-23T16:19:10.958Z",
    "updatedAt": "2026-03-23T16:19:10.958Z",
    "$or": {
      "runId": [
        "run-123456"
      ],
      "runName": [
        "Deploy to Production"
      ],
      "status": [
        "plan_success"
      ],
      "pullRequestUrl": [
        "https://github.com/org/repo/pull/123"
      ],
      "branch": [
        "main"
      ],
      "commitId": [
        "abc123def456"
      ],
      "ciTool": [
        "github-actions"
      ],
      "buildId": [
        "build-789012"
      ],
      "buildName": [
        "CI Build"
      ],
      "buildUrl": [
        "https://github.com/org/repo/actions/runs/789012"
      ],
      "vcsType": [
        "github"
      ],
      "repository": [
        "org/repo"
      ],
      "repositoryUrl": [
        "https://github.com/org/repo"
      ],
      "title": [
        "Update infrastructure for new feature"
      ],
      "createdAt": "2026-03-23T16:19:10.958Z",
      "updatedAt": "2026-03-23T16:19:10.958Z"
    }
  },
  "sort": {
    "updatedAt": {
      "order": -1
    },
    "title": {
      "order": -1
    },
    "commitId": {
      "order": -1
    },
    "branch": {
      "order": -1
    },
    "status": {
      "order": -1
    },
    "ciTool": {
      "order": -1
    },
    "vcsType": {
      "order": -1
    },
    "repository": {
      "order": -1
    }
  }
}

[
  {
    "id": "507f1f77bcf86cd799439011",
    "accountId": "507f1f77bcf86cd799439011",
    "createdAt": "2026-03-23T16:19:10.958Z",
    "updatedAt": "2026-03-23T16:19:10.958Z",
    "workspaceId": "507f1f77bcf86cd799439012",
    "workspaceName": "production-infra",
    "runId": "run-123456",
    "runName": "Deploy to Production",
    "status": "plan_success",
    "pullRequestId": "123",
    "pullRequestUrl": "https://github.com/org/repo/pull/123",
    "branch": "main",
    "commitId": "abc123def456",
    "commitUrl": "https://github.com/org/repo/commit/abc123def456",
    "runnerType": "github-actions",
    "buildId": "build-789012",
    "buildUrl": "https://github.com/org/repo/actions/runs/789012",
    "buildName": "CI Build",
    "vcsType": "github",
    "repo": "org/repo",
    "repoUrl": "https://github.com/org/repo",
    "ownerSummary": {
      "email": "[email protected]",
      "name": "John Doe",
      "initials": "JD",
      "customColor": "#00000F"
    },
    "title": "Update infrastructure for new feature",
    "terraformVersion": "1.0.11",
    "iacType": "terraform",
    "backendSummary": {
      "backendType": "s3",
      "backendConfig": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "iacStackId": "text",
      "managedResourceCount": 1
    },
    "planTaskId": "507f1f77bcf86cd799439013",
    "applyTaskId": "507f1f77bcf86cd799439014",
    "plan": [
      {
        "id": "507f1f77bcf86cd799439011",
        "accountId": "507f1f77bcf86cd799439011",
        "createdAt": "2026-03-23T16:19:10.958Z",
        "updatedAt": "2026-03-23T16:19:10.958Z",
        "contentKeys": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "completed",
        "resultStatus": "success",
        "type": "post-plan",
        "guardrailsSummary": {
          "total": 10,
          "passed": 8,
          "failed": 2,
          "violations": [
            {
              "id": "v1",
              "severity": "high",
              "message": "Resource does not have required tags"
            }
          ],
          "description": "text"
        },
        "backendSummary": {
          "type": "s3",
          "config": {
            "bucket": "terraform-state",
            "key": "prod/terraform.tfstate"
          },
          "resources": 42,
          "description": "text"
        },
        "changedFilesCodeSummary": {
          "total": 5,
          "added": 2,
          "modified": 3,
          "deleted": 0,
          "files": [
            {
              "path": "main.tf",
              "type": "modified"
            }
          ],
          "description": "text"
        },
        "vcsType": "github",
        "runnerType": "github-actions"
      }
    ],
    "apply": [
      {
        "id": "507f1f77bcf86cd799439011",
        "accountId": "507f1f77bcf86cd799439011",
        "createdAt": "2026-03-23T16:19:10.958Z",
        "updatedAt": "2026-03-23T16:19:10.958Z",
        "contentKeys": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "completed",
        "resultStatus": "success",
        "type": "post-plan",
        "guardrailsSummary": {
          "total": 10,
          "passed": 8,
          "failed": 2,
          "violations": [
            {
              "id": "v1",
              "severity": "high",
              "message": "Resource does not have required tags"
            }
          ],
          "description": "text"
        },
        "backendSummary": {
          "type": "s3",
          "config": {
            "bucket": "terraform-state",
            "key": "prod/terraform.tfstate"
          },
          "resources": 42,
          "description": "text"
        },
        "changedFilesCodeSummary": {
          "total": 5,
          "added": 2,
          "modified": 3,
          "deleted": 0,
          "files": [
            {
              "path": "main.tf",
              "type": "modified"
            }
          ],
          "description": "text"
        },
        "vcsType": "github",
        "runnerType": "github-actions"
      }
    ],
    "error": {
      "type": "text",
      "description": "text",
      "activity": "text",
      "temporalWorkflowId": "text",
      "cause": "text"
    }
  }
]

List Run Resources

post

Lists Resources Affected by a Run

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

runIdstringRequired

Unique identifier of the Run (use runId from list runs response)

Example: 60a097c0-d44c-4dea-af1b-1abdc5f2eea7Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

workspaceIdstringRequired

Unique identifier of the Workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query parameters

pageintegerOptionalDefault: 0

pageSizeinteger · min: 1OptionalDefault: 25

Body

application/json

projectionstring[]Optional

Fields to include in the response

searchValuestringOptional

Value to search for across searchable fields

modestring · enumRequired

The mode to display the resources in

Possible values:

Responses

200

Run resources retrieved successfully

application/json

or

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/workspaces/{workspaceId}/runs/{runId}/resources/search

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/runs/{runId}/resources/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 609

{
  "projection": [
    "text"
  ],
  "searchValue": "text",
  "mode": "table",
  "filters": {
    "action": {
      "0": "create"
    },
    "hasDiagnostics": true,
    "taskType": {
      "0": "post-plan"
    },
    "resourceId": {
      "0": "aws_s3_bucket.logs"
    },
    "providerName": [
      "aws"
    ],
    "isDrifted": false,
    "$or": {
      "action": {
        "0": "create"
      },
      "hasDiagnostics": true,
      "taskType": {
        "0": "post-plan"
      },
      "resourceId": {
        "0": "aws_s3_bucket.logs"
      },
      "providerName": [
        "aws"
      ],
      "isDrifted": false
    }
  },
  "sort": {
    "name": {
      "order": -1
    },
    "mode": {
      "order": -1
    },
    "action": {
      "order": -1
    },
    "isDrifted": {
      "order": -1
    },
    "type": {
      "order": -1
    },
    "taskType": {
      "order": -1
    },
    "providerName": {
      "order": -1
    },
    "updatedAt": {
      "order": -1
    },
    "createdAt": {
      "order": -1
    }
  }
}

{
  "resources": [
    {
      "id": "507f1f77bcf86cd799439011",
      "accountId": "507f1f77bcf86cd799439011",
      "createdAt": "2026-03-23T16:19:10.958Z",
      "updatedAt": "2026-03-23T16:19:10.958Z",
      "taskId": "507f1f77bcf86cd799439013",
      "name": "aws_instance.example",
      "type": "aws_instance",
      "mode": "managed",
      "action": "create"
    },
    {
      "isDrifted": false,
      "taskType": "post-plan",
      "dataType": "terraform",
      "providerName": "aws",
      "providerType": "aws",
      "providerVersion": "4.0.0"
    }
  ]
}

List run changed code

post

Lists code changes grouped by folders with file metadata

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

runIdstringRequired

Unique identifier of the run (use runId from list runs response)

Example: 60a097c0-d44c-4dea-af1b-1abdc5f2eea7Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

workspaceIdstringRequired

Unique identifier of the Workspace

Example: 0e01b22c-7f4b-5e0f-b1c1-faff031977f8Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query parameters

pageintegerOptionalDefault: 0

pageSizeinteger · min: 1OptionalDefault: 25

Body

application/json

projectionstring[]Optional

Fields to include in the response

searchValuestringOptional

Value to search for across searchable fields

Responses

200

Run changed code retrieved successfully

application/json

Response containing changed files grouped by folder path

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/workspaces/{workspaceId}/runs/{runId}/changed-files-code/search

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/runs/{runId}/changed-files-code/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "projection": [
    "text"
  ],
  "searchValue": "text",
  "filters": {
    "taskId": {
      "0": "507f1f77bcf86cd799439013"
    },
    "suffix": {
      "0": "tf"
    },
    "taskType": {
      "0": "post-plan"
    },
    "filePath": {
      "0": "infrastructure/main.tf"
    },
    "$or": {
      "taskId": {
        "0": "507f1f77bcf86cd799439013"
      },
      "suffix": {
        "0": "tf"
      },
      "taskType": {
        "0": "post-plan"
      },
      "filePath": {
        "0": "infrastructure/main.tf"
      }
    }
  },
  "sort": {
    "taskType": {
      "order": -1
    },
    "suffix": {
      "order": -1
    },
    "updatedAt": {
      "order": -1
    }
  }
}

{
  "infrastructure": [
    {
      "id": "507f1f77bcf86cd799439014",
      "filePath": "infrastructure/main.tf",
      "folderPath": "infrastructure",
      "fileSuffix": "tf",
      "changes": {
        "additions": 10,
        "deletions": 5
      }
    }
  ],
  "modules": [
    {
      "id": "507f1f77bcf86cd799439015",
      "filePath": "modules/network/main.tf",
      "folderPath": "modules/network",
      "fileSuffix": "tf",
      "changes": {
        "additions": 3,
        "deletions": 1
      }
    }
  ]
}

Guardrails

List Guardrail Rules

post

Returns a list of guardrails rules based on filter criteria

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

pageintegerOptionalDefault: 0

pageSizeinteger · min: 1OptionalDefault: 25

Body

application/json

projectionstring[]Optional

Fields to include in the response

searchValuestringOptional

Value to search for across searchable fields

Responses

200

List of guardrail rules retrieved successfully

application/json

idstringRead-onlyOptional

Unique identifier of the guardrail rule

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

accountIdstringOptional

Unique identifier of the associated account

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

createdBystring · min: 1Optional

Name of the user who created the rule

Example: John Doe

namestring · min: 1Optional

Name of the guardrail rule

typestring · enumOptional

Type of the guardrail rule

Possible values:

isEnabledbooleanOptional

Whether the rule is enabled

createdAtstring · date-timeOptional

Timestamp when the rule was created

updatedAtstring · date-timeOptional

Timestamp when the rule was last updated

notificationIdstringOptional

Unique identifier of the associated notification configuration

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

severityinteger · enumOptional

Severity level of the guardrail rule

Possible values:

enforceOnNoOpbooleanOptional

Whether to enforce the rule on no-op assets

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/guardrails/search

HTTPcURLJavaScriptPython

POST /guardrails/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 496

{
  "projection": [
    "text"
  ],
  "searchValue": "text",
  "filters": {
    "createdBy": [
      "John Doe"
    ],
    "type": [
      "policy",
      "cost"
    ],
    "labels": [
      "production"
    ],
    "repositories": [
      "my-repo"
    ],
    "workspaces": [
      "my-workspace"
    ],
    "branches": [
      "main"
    ],
    "$or": {
      "createdBy": [
        "John Doe"
      ],
      "type": [
        "policy",
        "cost"
      ],
      "labels": [
        "production"
      ],
      "repositories": [
        "my-repo"
      ],
      "workspaces": [
        "my-workspace"
      ],
      "branches": [
        "main"
      ]
    }
  },
  "sort": [
    {
      "createdAt": {
        "order": -1
      },
      "accountId": {
        "order": -1
      },
      "createdBy": {
        "order": -1
      },
      "name": {
        "order": -1
      },
      "severity": {
        "order": -1
      }
    }
  ]
}

[
  {
    "id": "507f1f77bcf86cd799439012",
    "accountId": "507f1f77bcf86cd799439012",
    "createdBy": "John Doe",
    "name": "text",
    "type": "policy",
    "scope": {
      "workspaces": {
        "include": null,
        "exclude": [
          "text"
        ]
      },
      "repositories": {
        "include": null,
        "exclude": [
          "text"
        ]
      },
      "branches": {
        "include": null,
        "exclude": [
          "text"
        ]
      },
      "labels": {
        "include": null,
        "exclude": [
          "text"
        ]
      }
    },
    "criteria": {
      "cost": {
        "thresholdAmount": 1,
        "thresholdPercentage": 1
      },
      "policy": {
        "severity": "text",
        "policies": {
          "include": [
            "text"
          ],
          "exclude": [
            "text"
          ]
        }
      },
      "resource": {
        "actions": [
          "create"
        ],
        "regions": {
          "include": null,
          "exclude": [
            "text"
          ]
        },
        "assetTypes": {
          "include": null,
          "exclude": [
            "text"
          ]
        },
        "specificResources": [
          "text"
        ]
      },
      "tag": {
        "tagEnforcementMode": "anyTags"
      }
    },
    "isEnabled": true,
    "createdAt": "2026-03-23T16:19:10.958Z",
    "updatedAt": "2026-03-23T16:19:10.958Z",
    "notificationId": "507f1f77bcf86cd799439012",
    "severity": 0,
    "enforceOnNoOp": true
  }
]

Create a new Guardrail Rule

post

Creates a new guardrail rule with optional notification setup

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

idstringRead-onlyOptional

Unique identifier of the guardrail rule

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

accountIdstringOptional

Unique identifier of the associated account

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

createdBystring · min: 1Required

Name of the user who created the rule

Example: John Doe

namestring · min: 1Required

Name of the guardrail rule

typestring · enumRequired

Type of the guardrail rule

Possible values:

isEnabledbooleanRequired

Whether the rule is enabled

createdAtstring · date-timeOptional

Timestamp when the rule was created

updatedAtstring · date-timeOptional

Timestamp when the rule was last updated

notificationIdstringOptional

Unique identifier of the associated notification configuration

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

severityinteger · enumRequired

Severity level of the guardrail rule

Possible values:

enforceOnNoOpbooleanOptional

Whether to enforce the rule on no-op assets

Responses

200

Guardrail Rule Created Successfully

application/json

ruleIdstringRequired

Unique identifier of the created rule

Example: 507f1f77bcf86cd799439011Pattern: ^[0-9a-fA-F]{24}$

notificationIdstringRequired

Unique identifier of the created notification

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/guardrails

HTTPcURLJavaScriptPython

POST /guardrails HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 811

{
  "accountId": "507f1f77bcf86cd799439012",
  "createdBy": "John Doe",
  "name": "text",
  "type": "policy",
  "scope": {
    "workspaces": {
      "include": null,
      "exclude": [
        "text"
      ]
    },
    "repositories": {
      "include": null,
      "exclude": [
        "text"
      ]
    },
    "branches": {
      "include": null,
      "exclude": [
        "text"
      ]
    },
    "labels": {
      "include": null,
      "exclude": [
        "text"
      ]
    }
  },
  "criteria": {
    "cost": {
      "thresholdAmount": 1,
      "thresholdPercentage": 1
    },
    "policy": {
      "severity": "text",
      "policies": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      }
    },
    "resource": {
      "actions": [
        "create"
      ],
      "regions": {
        "include": null,
        "exclude": [
          "text"
        ]
      },
      "assetTypes": {
        "include": null,
        "exclude": [
          "text"
        ]
      },
      "specificResources": [
        "text"
      ]
    },
    "tag": {
      "tagEnforcementMode": "anyTags"
    }
  },
  "isEnabled": true,
  "createdAt": "2026-03-23T16:19:10.958Z",
  "updatedAt": "2026-03-23T16:19:10.958Z",
  "notificationId": "507f1f77bcf86cd799439012",
  "severity": 0,
  "enforceOnNoOp": true
}

{
  "ruleId": "507f1f77bcf86cd799439011",
  "notificationId": "507f1f77bcf86cd799439012"
}

Update a Guardrail Rule

patch

Updates an existing Guardrail Rule and its Notifications

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

ruleIdstringRequired

Unique identifier of the Guardrail Rule

Example: 684aac91c3f9b3880d3ece51Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

idstringRead-onlyOptional

Unique identifier of the guardrail rule

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

accountIdstringOptional

Unique identifier of the associated account

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

createdBystring · min: 1Optional

Name of the user who created the rule

Example: John Doe

namestring · min: 1Required

Name of the guardrail rule

typestring · enumRequired

Type of the guardrail rule

Possible values:

isEnabledbooleanRequired

Whether the rule is enabled

createdAtstring · date-timeOptional

Timestamp when the rule was created

updatedAtstring · date-timeOptional

Timestamp when the rule was last updated

notificationIdstringOptional

Unique identifier of the associated notification configuration

Example: 507f1f77bcf86cd799439012Pattern: ^[0-9a-fA-F]{24}$

severityinteger · enumOptional

Severity level of the guardrail rule

Possible values:

enforceOnNoOpbooleanOptional

Whether to enforce the rule on no-op assets

Responses

200

Guardrail Rule Updated Successfully

application/json

idstringRequired

Unique identifier of the updated rule

Example: 507f1f77bcf86cd799439011Pattern: ^[0-9a-fA-F]{24}$

namestring · min: 1 · max: 100Required

Name of the Guardrail Rule

Example: Enforce S3 Encryption

enabledbooleanRequired

Whether the Rule is Active

Example: true

updatedAtstring · date-timeRequired

Timestamp of the Last Update

Example: 2024-11-11T10:00:00Z

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

patch

/guardrails/{ruleId}

HTTPcURLJavaScriptPython

PATCH /guardrails/{ruleId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 811

{
  "accountId": "507f1f77bcf86cd799439012",
  "createdBy": "John Doe",
  "name": "text",
  "type": "policy",
  "scope": {
    "workspaces": {
      "include": null,
      "exclude": [
        "text"
      ]
    },
    "repositories": {
      "include": null,
      "exclude": [
        "text"
      ]
    },
    "branches": {
      "include": null,
      "exclude": [
        "text"
      ]
    },
    "labels": {
      "include": null,
      "exclude": [
        "text"
      ]
    }
  },
  "criteria": {
    "cost": {
      "thresholdAmount": 1,
      "thresholdPercentage": 1
    },
    "policy": {
      "severity": "text",
      "policies": {
        "include": [
          "text"
        ],
        "exclude": [
          "text"
        ]
      }
    },
    "resource": {
      "actions": [
        "create"
      ],
      "regions": {
        "include": null,
        "exclude": [
          "text"
        ]
      },
      "assetTypes": {
        "include": null,
        "exclude": [
          "text"
        ]
      },
      "specificResources": [
        "text"
      ]
    },
    "tag": {
      "tagEnforcementMode": "anyTags"
    }
  },
  "isEnabled": true,
  "createdAt": "2026-03-23T16:19:10.958Z",
  "updatedAt": "2026-03-23T16:19:10.958Z",
  "notificationId": "507f1f77bcf86cd799439012",
  "severity": 0,
  "enforceOnNoOp": true
}

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Enforce S3 Encryption",
  "enabled": true,
  "updatedAt": "2024-11-11T10:00:00Z"
}

Delete a Guardrail Rule

delete

Deletes a Guardrail Rule and its Associated Notification

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

ruleIdstringRequired

Unique identifier of the Guardrail Rule

Example: 684aac91c3f9b3880d3ece51Pattern: ^[0-9a-fA-F]{24}$

Responses

200

Guardrail Rule Deleted Successfully

application/json

statusinteger · enumRequired

HTTP Status Code

Example: 200Possible values:

messagestringRequired

Success message

Example: Guardrail rule and notification deleted successfully

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

delete

/guardrails/{ruleId}

HTTPcURLJavaScriptPython

DELETE /guardrails/{ruleId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "message": "Guardrail rule and notification deleted successfully"
}

Projects

Create a project

post

Creates a new project

Authorizations

JWTAuthBasicAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

namestringRequired

Name of the project

descriptionstringOptional

Description of the project

labelsstring[]Optional

Labels to assign to the project

poolIdstring · uuidOptional

UUID of the runner pool associated with the project

Example: 123e4567-e89b-12d3-a456-426614174000

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

oidcAuthenticationboolean · nullableOptional

OIDC authentication setting.

parentIdstringOptional

ID of the parent project. If missing or empty, the server will attempt to create a root project.

Responses

201

Project created successfully

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/runners/projects

HTTPcURLJavaScriptPython

POST /runners/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "name": "text",
  "description": "text",
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "cronExecutionPattern": "text",
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ],
  "oidcAuthentication": true,
  "parentId": "text"
}

{
  "name": "text",
  "description": "text",
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "cronExecutionPattern": "text",
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ],
  "oidcAuthentication": true,
  "id": "text",
  "accountId": "text",
  "membersCount": 1,
  "workspaceCount": 1,
  "parentId": "text"
}

Get a project

get

Retrieves a single project by ID

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Unique identifier of the project to retrieve

Responses

200

Project retrieved successfully

application/json

namestringOptional

Name of the project

descriptionstringOptional

Description of the project

labelsstring[]Optional

Labels to assign to the project

poolIdstring · uuidOptional

UUID of the runner pool associated with the project

Example: 123e4567-e89b-12d3-a456-426614174000

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

oidcAuthenticationboolean · nullableOptional

OIDC authentication setting.

idstringOptional

Unique identifier for the project

accountIdstringOptional

ID of the account the project belongs to

membersCountintegerOptional

Number of members assigned to the project

workspaceCountintegerOptional

Number of workspaces in the project

parentIdstringOptional

ID of the parent project (for nested projects)

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

get

/runners/projects/{projectId}

HTTPcURLJavaScriptPython

GET /runners/projects/{projectId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "description": "text",
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "cronExecutionPattern": "text",
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ],
  "oidcAuthentication": true,
  "id": "text",
  "accountId": "text",
  "membersCount": 1,
  "workspaceCount": 1,
  "parentId": "text"
}

Update a project

patch

Updates an existing project

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Unique identifier of the project to update

Body

application/json

namestringOptional

Name of the project

descriptionstringOptional

Description of the project

labelsstring[]Optional

Labels to assign to the project

poolIdstring · uuidOptional

UUID of the runner pool associated with the project

Example: 123e4567-e89b-12d3-a456-426614174000

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

oidcAuthenticationboolean · nullableOptional

OIDC authentication setting.

Responses

200

Project updated successfully

application/json

namestringOptional

Name of the project

descriptionstringOptional

Description of the project

labelsstring[]Optional

Labels to assign to the project

poolIdstring · uuidOptional

UUID of the runner pool associated with the project

Example: 123e4567-e89b-12d3-a456-426614174000

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

oidcAuthenticationboolean · nullableOptional

OIDC authentication setting.

idstringOptional

Unique identifier for the project

accountIdstringOptional

ID of the account the project belongs to

membersCountintegerOptional

Number of members assigned to the project

workspaceCountintegerOptional

Number of workspaces in the project

parentIdstringOptional

ID of the parent project (for nested projects)

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

patch

/runners/projects/{projectId}

HTTPcURLJavaScriptPython

PATCH /runners/projects/{projectId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "name": "text",
  "description": "text",
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "cronExecutionPattern": "text",
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ],
  "oidcAuthentication": true
}

{
  "name": "text",
  "description": "text",
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "cronExecutionPattern": "text",
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ],
  "oidcAuthentication": true,
  "id": "text",
  "accountId": "text",
  "membersCount": 1,
  "workspaceCount": 1,
  "parentId": "text"
}

Delete a project

delete

Deletes a project and all its associated workspaces

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Unique identifier of the project to delete

Responses

204

Project successfully deleted

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

delete

/runners/projects/{projectId}

HTTPcURLJavaScriptPython

DELETE /runners/projects/{projectId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List projects in flat structure

get

Retrieves all projects with pagination support

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

pageSizeinteger · min: 1OptionalDefault: 25

offsetintegerOptional

The offset of the items to return

Default: 0

maxDepthinteger · max: 5Optional

Maximum depth of the project tree to return

poolIdstringOptional

Filter projects by runner pool ID

Responses

200

Projects retrieved successfully in flat list format

application/json

totalCountintegerOptional

Total count of projects

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/runners/projects/list

HTTPcURLJavaScriptPython

GET /runners/projects/list HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "labels": [
        "text"
      ],
      "poolId": "123e4567-e89b-12d3-a456-426614174000",
      "cronExecutionPattern": "text",
      "variables": [
        {
          "key": "text",
          "value": "text",
          "sensitivity": "string",
          "destination": "env"
        }
      ],
      "oidcAuthentication": true,
      "id": "text",
      "accountId": "text",
      "membersCount": 1,
      "workspaceCount": 1,
      "parentId": "text"
    }
  ],
  "totalCount": 1
}

List projects in tree structure

get

Retrieves all projects in a hierarchical tree format

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

searchQuerystringOptional

Search query

variableSetIdstringOptional

Filter projects by variable set ID

consumedOnlybooleanOptional

When used with variableSetId, only return projects that consume the variable set

Responses

200

Projects retrieved successfully in tree format

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/runners/projects/tree

HTTPcURLJavaScriptPython

GET /runners/projects/tree HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "data": [
        {
          "name": "text",
          "description": "text",
          "labels": [
            "text"
          ],
          "poolId": "123e4567-e89b-12d3-a456-426614174000",
          "cronExecutionPattern": "text",
          "variables": [
            {
              "key": "text",
              "value": "text",
              "sensitivity": "string",
              "destination": "env"
            }
          ],
          "oidcAuthentication": true,
          "id": "text",
          "accountId": "text",
          "membersCount": 1,
          "workspaceCount": 1,
          "parentId": "text"
        },
        {
          "hasChildren": true,
          "children": [
            {
              "name": "text",
              "description": "text",
              "labels": [
                "text"
              ],
              "poolId": "123e4567-e89b-12d3-a456-426614174000",
              "cronExecutionPattern": "text",
              "variables": [
                {
                  "key": "text",
                  "value": "text",
                  "sensitivity": "string",
                  "destination": "env"
                }
              ],
              "oidcAuthentication": true,
              "id": "text",
              "accountId": "text",
              "membersCount": 1,
              "workspaceCount": 1,
              "parentId": "text"
            }
          ],
          "ancestors": [
            {
              "name": "text",
              "description": "text",
              "labels": [
                "text"
              ],
              "poolId": "123e4567-e89b-12d3-a456-426614174000",
              "cronExecutionPattern": "text",
              "variables": [
                {
                  "key": "text",
                  "value": "text",
                  "sensitivity": "string",
                  "destination": "env"
                }
              ],
              "oidcAuthentication": true,
              "id": "text",
              "accountId": "text",
              "membersCount": 1,
              "workspaceCount": 1,
              "parentId": "text"
            }
          ]
        }
      ]
    }
  ]
}

List members of a project

get

Retrieves all members of a specified project

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Unique identifier of the project

Responses

200

Members retrieved successfully

application/json

userIdstringRequired

ID of the user

rolestring · enumRequired

Role of the user in the project

Possible values:

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

get

/runners/projects/{projectId}/members

HTTPcURLJavaScriptPython

GET /runners/projects/{projectId}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "userId": "text",
    "role": "admin"
  }
]

Add members to a project

post

Adds new members to a specified project

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Unique identifier of the project

Bodyobject[]

application/json

userIdstringRequired

ID of the user

rolestring · enumRequired

Role of the user in the project

Possible values:

Responses

201

Members added successfully

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/runners/projects/{projectId}/members

HTTPcURLJavaScriptPython

POST /runners/projects/{projectId}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

[
  {
    "userId": "text",
    "role": "admin"
  }
]

[
  {
    "userId": "text",
    "role": "admin"
  }
]

Remove members from a project

delete

Deletes specified members from a project

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Unique identifier of the project

Bodystring[]

application/json

string[]Optional

User IDs of the members to remove

Responses

204

Members removed successfully

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

delete

/runners/projects/{projectId}/members

HTTPcURLJavaScriptPython

DELETE /runners/projects/{projectId}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

List workspaces of a project

get

Retrieves all workspaces of a specified project

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Unique identifier of the project

Query parameters

searchQuerystringOptional

Search query

pageSizeinteger · min: 1OptionalDefault: 25

offsetintegerOptional

The offset of the items to return

Default: 0

poolIdstringOptional

Filter workspaces by runner pool ID

variableSetIdstringOptional

If provided, only workspaces that consume the variable set will be returned

explicitConsumptionbooleanOptional

If true, only workspaces that have an explicit consumption of the variable set will be returned. Must be used in conjunction with variableSetId

Responses

200

Workspaces retrieved successfully

application/json

idstringOptional

Unique identifier for the workspace

namestringRequired

Name of the workspace

descriptionstringOptional

Description of the workspace

accountIdstringOptional

ID of the account the workspace belongs to

repositorystringRequired

Repository URL for the workspace

workingDirectorystringOptional

Working directory within the repository

vcsIntegrationIdstringRequired

ID of the VCS integration

vcsstringRequired

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

defaultBranchstringRequired

Default branch for the workspace

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

labelsstring[]Optional

Labels assigned to the workspace

poolIdstringOptional

ID of the runner pool associated with the workspace

Example: 123e4567-e89b-12d3-a456-426614174000

oidcAuthenticationboolean · nullableOptional

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

isRemotebooleanOptional

Whether this workspace uses the internal remote backend for state management

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

get

/runners/projects/{projectId}/workspaces

HTTPcURLJavaScriptPython

GET /runners/projects/{projectId}/workspaces HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "accountId": "text",
    "repository": "text",
    "workingDirectory": "text",
    "vcsIntegrationId": "text",
    "vcs": "text",
    "defaultBranch": "text",
    "cronExecutionPattern": "text",
    "iacProvisioner": {
      "type": "terraform",
      "version": "text"
    },
    "multiEnvProvisioner": {
      "type": "terragrunt",
      "version": "text",
      "applyAll": false,
      "stopOnError": false
    },
    "labels": [
      "text"
    ],
    "poolId": "123e4567-e89b-12d3-a456-426614174000",
    "triggerConfig": {
      "runOnPullRequest": true,
      "runOnPush": true,
      "autoApply": false
    },
    "oidcAuthentication": true,
    "isRemote": true
  }
]

List all project labels

get

Retrieves all available project labels for the account

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Responses

200

Project labels retrieved successfully

application/json

string[]Optional

List of project labels

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/runners/projects/labels

HTTPcURLJavaScriptPython

GET /runners/projects/labels HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

Variables Management

Project Variables

List variables for a project

get

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Responses

200

List of project variables

application/json

keystringOptional

valuestringOptional

sensitivitystring · enumOptionalPossible values:

destinationstring · enumOptionalPossible values:

get

/runners/variables/projects/{projectId}

HTTPcURLJavaScriptPython

GET /runners/variables/projects/{projectId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of project variables

[
  {
    "key": "text",
    "value": "text",
    "sensitivity": "string",
    "destination": "env",
    "origin": {
      "type": "project",
      "fullName": "text",
      "fullId": "text",
      "variableSetFullName": "text",
      "variableSetFullId": "text",
      "consumerType": "project",
      "projectDepth": 1,
      "variableSetDepth": 1,
      "variableSetId": "text"
    }
  }
]

Upsert variables within a project (create or update)

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Body

application/json

Responses

204

Variables upserted within project

post

/runners/variables/projects/{projectId}/variables

HTTPcURLJavaScriptPython

POST /runners/variables/projects/{projectId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ]
}

204

Variables upserted within project

No content

Delete variables from a project

delete

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

Body

application/json

variableKeysstring[] · min: 1Required

Array of variable keys to delete

Responses

204

Variables deleted from project

delete

/runners/variables/projects/{projectId}/variables

HTTPcURLJavaScriptPython

DELETE /runners/variables/projects/{projectId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "variableKeys": [
    "text"
  ]
}

204

Variables deleted from project

No content

Workspace Variables

List variables for a workspace

get

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Query parameters

pageSizeintegerOptional

offsetintegerOptional

Responses

200

List of workspace variables

application/json

keystringOptional

valuestringOptional

sensitivitystring · enumOptionalPossible values:

destinationstring · enumOptionalPossible values:

get

/runners/variables/workspaces/{workspaceId}/variables

HTTPcURLJavaScriptPython

GET /runners/variables/workspaces/{workspaceId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of workspace variables

[
  {
    "key": "text",
    "value": "text",
    "sensitivity": "string",
    "destination": "env",
    "origin": {
      "type": "project",
      "fullName": "text",
      "fullId": "text",
      "variableSetFullName": "text",
      "variableSetFullId": "text",
      "consumerType": "project",
      "projectDepth": 1,
      "variableSetDepth": 1,
      "variableSetId": "text"
    }
  }
]

Upsert variables within a workspace (create or update)

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Body

application/json

Responses

204

Variables upserted within workspace

post

/runners/variables/workspaces/{workspaceId}/variables

HTTPcURLJavaScriptPython

POST /runners/variables/workspaces/{workspaceId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "variables": [
    {
      "variableId": "text",
      "variableData": {
        "key": "text",
        "value": "text",
        "sensitivity": "string",
        "destination": "env",
        "origin": "project"
      }
    }
  ]
}

204

Variables upserted within workspace

No content

Delete variables from a workspace

delete

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Body

application/json

variableIdsstring[] · min: 1Required

Array of variable IDs to delete

Responses

204

Variables deleted from workspace

delete

/runners/variables/workspaces/{workspaceId}/variables

HTTPcURLJavaScriptPython

DELETE /runners/variables/workspaces/{workspaceId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "variableIds": [
    "text"
  ]
}

204

Variables deleted from workspace

No content

Variable Sets

List variable sets

get

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

searchQuerystringOptional

pageSizeintegerOptional

offsetintegerOptional

Responses

200

List of variable sets

application/json

idstringOptional

Unique identifier for the variable set

versionintegerOptional

Version number of the variable set

namestringOptional

Name of the variable set

descriptionstringOptional

Description of the variable set

labelsstring[]Optional

Labels assigned to the variable set

parentsstring[]Optional

Parent variable set IDs

get

/runners/variables/variable-sets

HTTPcURLJavaScriptPython

GET /runners/variables/variable-sets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of variable sets

[
  {
    "id": "text",
    "version": 1,
    "name": "text",
    "description": "text",
    "labels": [
      "text"
    ],
    "parents": [
      "text"
    ],
    "variables": [
      {
        "key": "text",
        "value": "text",
        "sensitivity": "string",
        "destination": "env"
      }
    ],
    "descendants": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "consumers": {
      "workspaces": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "projects": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
]

Create a new variable set

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

namestringRequired

Name of the variable set

descriptionstringOptional

Description of the variable set

labelsstring[]Optional

Labels to assign to the variable set

parentsstring[]Optional

Parent variable set IDs

Responses

201

Variable set created successfully

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/runners/variables/variable-sets

HTTPcURLJavaScriptPython

POST /runners/variables/variable-sets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "name": "text",
  "description": "text",
  "labels": [
    "text"
  ],
  "parents": [
    "text"
  ],
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ]
}

{
  "variableSetId": "text"
}

Get a variable set

get

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

variableSetIdstringRequired

Responses

200

Variable set

application/json

idstringOptional

versionintegerOptional

consumablebooleanOptional

namestringOptional

labelsstring[]Optional

descriptionstringOptional

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/runners/variables/variable-sets/{variableSetId}

HTTPcURLJavaScriptPython

GET /runners/variables/variable-sets/{variableSetId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "version": 1,
  "consumable": true,
  "name": "text",
  "labels": [
    "text"
  ],
  "description": "text",
  "parents": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "descendants": [
    {
      "id": "text",
      "name": "text",
      "parentId": "text",
      "relativeDepth": 1
    }
  ],
  "consumers": {
    "workspaces": [
      {
        "id": "text",
        "name": "text",
        "parentProjectId": "text"
      }
    ],
    "projects": [
      {
        "id": "text",
        "name": "text",
        "parentId": "text",
        "relativeDepth": 1
      }
    ]
  }
}

Update a variable set

put

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

variableSetIdstringRequired

Body

application/json

namestringOptional

Name of the variable set

descriptionstringOptional

Description of the variable set

labelsstring[]Optional

Labels to assign to the variable set

parentsstring[]Optional

Parent variable set IDs

Responses

204

Variable set updated successfully

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

put

/runners/variables/variable-sets/{variableSetId}

HTTPcURLJavaScriptPython

PUT /runners/variables/variable-sets/{variableSetId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "name": "text",
  "description": "text",
  "labels": [
    "text"
  ],
  "parents": [
    "text"
  ],
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ]
}

No content

Delete a variable set

delete

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

variableSetIdstringRequired

Responses

204

Variable set deleted successfully

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

delete

/runners/variables/variable-sets/{variableSetId}

HTTPcURLJavaScriptPython

DELETE /runners/variables/variable-sets/{variableSetId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List variables in a variable set

get

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

variableSetIdstringRequired

Query parameters

pageintegerOptionalDefault: 0

pageSizeinteger · min: 1OptionalDefault: 25

Responses

200

List of variables in variable set

application/json

keystringOptional

valuestringOptional

sensitivitystring · enumOptionalPossible values:

destinationstring · enumOptionalPossible values:

get

/runners/variables/variable-sets/{variableSetId}/variables

HTTPcURLJavaScriptPython

GET /runners/variables/variable-sets/{variableSetId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of variables in variable set

[
  {
    "key": "text",
    "value": "text",
    "sensitivity": "string",
    "destination": "env",
    "origin": {
      "type": "project",
      "fullName": "text",
      "fullId": "text",
      "variableSetFullName": "text",
      "variableSetFullId": "text",
      "consumerType": "project",
      "projectDepth": 1,
      "variableSetDepth": 1,
      "variableSetId": "text"
    }
  }
]

Upsert variables within a variable set (create or update)

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

variableSetIdstringRequired

Body

application/json

Responses

204

Variables upserted within variable set

post

/runners/variables/variable-sets/{variableSetId}/variables

HTTPcURLJavaScriptPython

POST /runners/variables/variable-sets/{variableSetId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ]
}

204

Variables upserted within variable set

No content

Delete variables from a variable set

delete

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

variableSetIdstringRequired

Body

application/json

variableIdsstring[] · min: 1Required

Array of variable IDs to delete

Responses

204

Variables deleted from variable set

delete

/runners/variables/variable-sets/{variableSetId}/variables

HTTPcURLJavaScriptPython

DELETE /runners/variables/variable-sets/{variableSetId}/variables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "variableIds": [
    "text"
  ]
}

204

Variables deleted from variable set

No content

Variable Set Operations

Attach a variable set to a project

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

variableSetIdstringRequired

Body

application/json

consumebooleanRequired

Whether to consume the variable set values

Default: true

Responses

204

Variable set attached to project

post

/runners/variables/projects/{projectId}/variable-sets/{variableSetId}/attach

HTTPcURLJavaScriptPython

POST /runners/variables/projects/{projectId}/variable-sets/{variableSetId}/attach HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "consume": true
}

204

Variable set attached to project

No content

Detach a variable set from a project

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

projectIdstringRequired

variableSetIdstringRequired

Responses

204

Variable set detached from project

post

/runners/variables/projects/{projectId}/variable-sets/{variableSetId}/detach

HTTPcURLJavaScriptPython

POST /runners/variables/projects/{projectId}/variable-sets/{variableSetId}/detach HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Variable set detached from project

No content

Bind a variable set to a workspace

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

variableSetIdstringRequired

Responses

204

Variable set bound to workspace

post

/runners/variables/workspaces/{workspaceId}/variable-sets/{variableSetId}/bind

HTTPcURLJavaScriptPython

POST /runners/variables/workspaces/{workspaceId}/variable-sets/{variableSetId}/bind HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Variable set bound to workspace

No content

Unbind a variable set from a workspace

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

variableSetIdstringRequired

Responses

204

Variable set unbound from workspace

post

/runners/variables/workspaces/{workspaceId}/variable-sets/{variableSetId}/unbind

HTTPcURLJavaScriptPython

POST /runners/variables/workspaces/{workspaceId}/variable-sets/{variableSetId}/unbind HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Variable set unbound from workspace

No content

Runners Workspaces

Create a new workspace

post

Creates a new workspace with the provided configuration

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

runnerTypestringRequired

Type of runner (e.g., firefly_runners)

Example: firefly_runners

iacTypestringRequired

Infrastructure as Code type

Example: terraform

workspaceNamestringRequired

Unique workspace name

Example: my-workspace

descriptionstringOptional

Workspace description

Example: Production environment workspace

labelsstring[]Optional

Labels assigned to the workspace

Example: ["production","terraform"]

vcsIdstringRequired

VCS integration ID

Example: 5fd126f5744410407fbc552f

repostringRequired

Repository name

Example: infralight/appiac

defaultBranchstringRequired

Default branch

Example: main

vcsTypestringRequired

VCS type (github, gitlab, etc.)

Example: github

workDirstringRequired

Working directory path

Example: terraform/production

consumedVariableSetsstring[]Optional

Array of variable set IDs that this workspace consumes

Example: ["var-set-1","var-set-2"]

projectstring · nullableOptional

Project ID or null for global access

terraformVariablesobjectOptional

Cleaned by deleteMockArrays

terraformSensitiveVariablesobjectOptional

Cleaned by deleteMockArrays

providersCredentialsobjectOptional

Cleaned by deleteMockArrays

runnerEnvironmentobjectOptional

Cleaned by deleteMockArrays

poolIdstringOptional

ID of the runner pool associated with the workspace

Example: 123e4567-e89b-12d3-a456-426614174000

oidcAuthenticationboolean · nullableOptional

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

isRemotebooleanOptional

Whether this workspace uses the internal remote backend for state management

Responses

201

Workspace created successfully

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

post

/runners/workspaces

HTTPcURLJavaScriptPython

POST /runners/workspaces HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 890

{
  "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",
  "variables": [
    {
      "key": "text",
      "value": "text",
      "sensitivity": "string",
      "destination": "env"
    }
  ],
  "consumedVariableSets": [
    "var-set-1",
    "var-set-2"
  ],
  "execution": {
    "triggers": [
      "merge"
    ],
    "applyRule": "manual",
    "terraformVersion": "1.5.7"
  },
  "project": null,
  "terraformVariables": {},
  "terraformSensitiveVariables": {},
  "providersCredentials": {},
  "runnerEnvironment": {},
  "iacProvisioner": {
    "type": "terraform",
    "version": "text"
  },
  "multiEnvProvisioner": {
    "type": "terragrunt",
    "version": "text",
    "applyAll": false,
    "stopOnError": false
  },
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "oidcAuthentication": true,
  "isRemote": true
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "accountId": "text",
  "repository": "text",
  "workingDirectory": "text",
  "vcsIntegrationId": "text",
  "vcs": "text",
  "defaultBranch": "text",
  "cronExecutionPattern": "text",
  "iacProvisioner": {
    "type": "terraform",
    "version": "text"
  },
  "multiEnvProvisioner": {
    "type": "terragrunt",
    "version": "text",
    "applyAll": false,
    "stopOnError": false
  },
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "triggerConfig": {
    "runOnPullRequest": true,
    "runOnPush": true,
    "autoApply": false
  },
  "oidcAuthentication": true,
  "isRemote": true
}

List all workspace labels

get

Retrieves all available workspace labels for the account

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Responses

200

Workspace labels retrieved successfully

application/json

string[]Optional

List of workspace labels

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

500

Internal Server Error

application/json

get

/runners/workspaces/labels

HTTPcURLJavaScriptPython

GET /runners/workspaces/labels HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

Get workspace details

get

Retrieves details for a specific workspace

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Responses

200

Workspace details retrieved successfully

application/json

idstringOptional

Unique identifier for the workspace

namestringRequired

Name of the workspace

descriptionstringOptional

Description of the workspace

accountIdstringOptional

ID of the account the workspace belongs to

repositorystringRequired

Repository URL for the workspace

workingDirectorystringOptional

Working directory within the repository

vcsIntegrationIdstringRequired

ID of the VCS integration

vcsstringRequired

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

defaultBranchstringRequired

Default branch for the workspace

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

labelsstring[]Optional

Labels assigned to the workspace

poolIdstringOptional

ID of the runner pool associated with the workspace

Example: 123e4567-e89b-12d3-a456-426614174000

oidcAuthenticationboolean · nullableOptional

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

isRemotebooleanOptional

Whether this workspace uses the internal remote backend for state management

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

get

/runners/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

GET /runners/workspaces/{workspaceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "accountId": "text",
  "repository": "text",
  "workingDirectory": "text",
  "vcsIntegrationId": "text",
  "vcs": "text",
  "defaultBranch": "text",
  "cronExecutionPattern": "text",
  "iacProvisioner": {
    "type": "terraform",
    "version": "text"
  },
  "multiEnvProvisioner": {
    "type": "terragrunt",
    "version": "text",
    "applyAll": false,
    "stopOnError": false
  },
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "triggerConfig": {
    "runOnPullRequest": true,
    "runOnPush": true,
    "autoApply": false
  },
  "oidcAuthentication": true,
  "isRemote": true
}

Deploy workspace

post

Deploys a workspace by running plan or apply tasks based on the provided task type

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Body

application/json

taskTypestring · enumRequired

The type of task to run (plan or apply)

Possible values:

cmdArgumentsstringOptional

Additional command line arguments

Responses

200

Workspace deployed successfully

application/json

statusintegerOptionalExample: 200

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/runners/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

POST /runners/workspaces/{workspaceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "taskType": "plan",
  "vcs": {
    "reference": "text",
    "type": "branch"
  },
  "trigger": {
    "type": "manual"
  },
  "cmdArguments": "text"
}

{
  "status": 200,
  "data": {
    "message": "Workspace deployed successfully"
  }
}

Update a workspace

patch

Updates an existing workspace with the provided configuration

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Body

application/json

namestringOptional

Workspace name

Example: my-workspace

descriptionstringOptional

Workspace description

Example: Production environment workspace

labelsstring[]Optional

Labels assigned to the workspace

Example: ["production","terraform"]

vcsIntegrationIdstringOptional

VCS integration ID

Example: 5fd126f5744410407fbc552f

repositorystringOptional

Repository name

Example: infralight/appiac

defaultBranchstringOptional

Default branch

Example: main

vcsstringOptional

VCS type (github, gitlab, etc.)

Example: github

workingDirectorystringOptional

Working directory path

Example: terraform/production

runnerTypestringOptional

Type of runner (e.g., firefly_runners)

Example: firefly_runners

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

Example: 0 2 * * *

parentIdstring · nullableOptional

Project ID or null for global access

poolIdstringOptional

ID of the runner pool associated with the workspace

Example: 123e4567-e89b-12d3-a456-426614174000

oidcAuthenticationboolean · nullableOptional

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

Responses

200

Workspace updated successfully

application/json

idstringOptional

Unique identifier for the workspace

namestringRequired

Name of the workspace

descriptionstringOptional

Description of the workspace

accountIdstringOptional

ID of the account the workspace belongs to

repositorystringRequired

Repository URL for the workspace

workingDirectorystringOptional

Working directory within the repository

vcsIntegrationIdstringRequired

ID of the VCS integration

vcsstringRequired

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

defaultBranchstringRequired

Default branch for the workspace

cronExecutionPatternstringOptional

Cron pattern for scheduled executions

labelsstring[]Optional

Labels assigned to the workspace

poolIdstringOptional

ID of the runner pool associated with the workspace

Example: 123e4567-e89b-12d3-a456-426614174000

oidcAuthenticationboolean · nullableOptional

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

isRemotebooleanOptional

Whether this workspace uses the internal remote backend for state management

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

patch

/runners/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

PATCH /runners/workspaces/{workspaceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 654

{
  "name": "my-workspace",
  "description": "Production environment workspace",
  "labels": [
    "production",
    "terraform"
  ],
  "vcsIntegrationId": "5fd126f5744410407fbc552f",
  "repository": "infralight/appiac",
  "defaultBranch": "main",
  "vcs": "github",
  "workingDirectory": "terraform/production",
  "iacProvisioner": {
    "type": "terraform",
    "version": "text"
  },
  "multiEnvProvisioner": {
    "type": "terragrunt",
    "version": "text",
    "applyAll": false,
    "stopOnError": false
  },
  "runnerType": "firefly_runners",
  "triggerConfig": {
    "runOnPullRequest": true,
    "runOnPush": false,
    "autoApply": false
  },
  "cronExecutionPattern": "0 2 * * *",
  "parentId": null,
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "oidcAuthentication": true
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "accountId": "text",
  "repository": "text",
  "workingDirectory": "text",
  "vcsIntegrationId": "text",
  "vcs": "text",
  "defaultBranch": "text",
  "cronExecutionPattern": "text",
  "iacProvisioner": {
    "type": "terraform",
    "version": "text"
  },
  "multiEnvProvisioner": {
    "type": "terragrunt",
    "version": "text",
    "applyAll": false,
    "stopOnError": false
  },
  "labels": [
    "text"
  ],
  "poolId": "123e4567-e89b-12d3-a456-426614174000",
  "triggerConfig": {
    "runOnPullRequest": true,
    "runOnPush": true,
    "autoApply": false
  },
  "oidcAuthentication": true,
  "isRemote": true
}

Delete a workspace

delete

Deletes a specific workspace and optionally destroys its infrastructure resources

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Query parameters

destroybooleanOptional

Whether to destroy infrastructure resources before deleting the workspace

Default: false

descriptionstringOptional

Optional description for the deletion operation

Responses

200

Workspace deleted successfully

application/json

messagestringOptionalExample: Workspace deleted successfully

workspaceIdstringOptional

The ID of the deleted workspace

resourcesDestroyedbooleanOptional

Whether resources were destroyed

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

delete

/runners/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

DELETE /runners/workspaces/{workspaceId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Workspace deleted successfully",
  "workspaceId": "text",
  "resourcesDestroyed": true
}

Destroy workspace infrastructure resources

post

Initiates a destroy task to clean up cloud infrastructure resources managed by this workspace. This does not delete the workspace entity itself.

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

Body

application/json

Request to run a task on workspace infrastructure

descriptionstringOptional

Optional description for the task

Example: Running infrastructure task

taskIdstringOptional

Optional ID of the task to run

Example: task-12345

cmdArgumentsstringOptional

Optional command line arguments for the task

Example: -auto-approve

Responses

200

Destroy task initiated successfully

application/json

Response from task initiation

accountIdstringOptional

ID of the account

idstringRequired

ID of the created task

statusstring · enumRequired

Current status of the task

Possible values:

currentStepstring · enumOptional

Current step in the task execution

Possible values:

workspaceIdstringRequired

ID of the workspace the task is running on

typestring · enumRequired

Type of task that was executed

Possible values:

cmdArgumentsstringOptional

Command line arguments used for the task

createdAtstring · date-timeOptional

When the task was created

updatedAtstring · date-timeOptional

When the task was last updated

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/runners/workspaces/{workspaceId}/tasks/destroy

HTTPcURLJavaScriptPython

POST /runners/workspaces/{workspaceId}/tasks/destroy HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "description": "Running infrastructure task",
  "vcs": {
    "reference": "main",
    "type": "branch"
  },
  "trigger": {
    "type": "manual",
    "source": "Firefly"
  },
  "taskId": "task-12345",
  "cmdArguments": "-auto-approve"
}

{
  "accountId": "text",
  "id": "text",
  "status": "pending",
  "error": {
    "type": "UNEXPECTED",
    "description": "text"
  },
  "currentStep": "plan",
  "workspaceId": "text",
  "vcs": {
    "reference": "main",
    "type": "branch"
  },
  "trigger": {
    "type": "manual"
  },
  "type": "plan",
  "cmdArguments": "text",
  "createdAt": "2026-03-23T16:19:10.958Z",
  "updatedAt": "2026-03-23T16:19:10.958Z"
}

Manually trigger a apply on a task

post

Manually triggers a terraform apply for the specified task within the workspace

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

taskIdstringRequired

Unique identifier of the task

Body

application/json

taskTypestring · enumRequired

The type of task to run apply

Possible values:

cmdArgumentsstringOptional

Additional command line arguments

Responses

200

Manual apply triggered successfully

application/json

statusintegerOptionalExample: 200

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/runners/workspaces/{workspaceId}/tasks/{taskId}/apply

HTTPcURLJavaScriptPython

POST /runners/workspaces/{workspaceId}/tasks/{taskId}/apply HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "taskType": "apply",
  "vcs": {
    "reference": "text",
    "type": "branch"
  },
  "trigger": {
    "type": "manual"
  },
  "cmdArguments": "text"
}

{
  "status": 200,
  "data": {
    "message": "Manual apply triggered successfully"
  }
}

Discard a task

post

Discards the specified task within the workspace

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

taskIdstringRequired

Unique identifier of the task

Responses

202

Task discard operation has initiated successfully

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/runners/workspaces/{workspaceId}/tasks/{taskId}/discard

HTTPcURLJavaScriptPython

POST /runners/workspaces/{workspaceId}/tasks/{taskId}/discard HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Task Resources

post

Lists resources for a specific task within the workspace

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

taskIdstringRequired

Unique identifier of the task

Query parameters

pageintegerOptionalDefault: 0

pageSizeinteger · min: 1OptionalDefault: 25

Body

application/json

projectionstring[]Optional

Fields to include in the response

searchValuestringOptional

Value to search for across searchable fields

modestring · enumRequired

The mode to display the resources in

Possible values:

Responses

200

Task resources retrieved successfully

application/json

or

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/runners/workspaces/{workspaceId}/tasks/{taskId}/resources/search

HTTPcURLJavaScriptPython

POST /runners/workspaces/{workspaceId}/tasks/{taskId}/resources/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 609

{
  "projection": [
    "text"
  ],
  "searchValue": "text",
  "mode": "table",
  "filters": {
    "action": {
      "0": "create"
    },
    "hasDiagnostics": true,
    "taskType": {
      "0": "post-plan"
    },
    "resourceId": {
      "0": "aws_s3_bucket.logs"
    },
    "providerName": [
      "aws"
    ],
    "isDrifted": false,
    "$or": {
      "action": {
        "0": "create"
      },
      "hasDiagnostics": true,
      "taskType": {
        "0": "post-plan"
      },
      "resourceId": {
        "0": "aws_s3_bucket.logs"
      },
      "providerName": [
        "aws"
      ],
      "isDrifted": false
    }
  },
  "sort": {
    "name": {
      "order": -1
    },
    "mode": {
      "order": -1
    },
    "action": {
      "order": -1
    },
    "isDrifted": {
      "order": -1
    },
    "type": {
      "order": -1
    },
    "taskType": {
      "order": -1
    },
    "providerName": {
      "order": -1
    },
    "updatedAt": {
      "order": -1
    },
    "createdAt": {
      "order": -1
    }
  }
}

{
  "resources": [
    {
      "id": "507f1f77bcf86cd799439011",
      "accountId": "507f1f77bcf86cd799439011",
      "createdAt": "2026-03-23T16:19:10.958Z",
      "updatedAt": "2026-03-23T16:19:10.958Z",
      "taskId": "507f1f77bcf86cd799439013",
      "name": "aws_instance.example",
      "type": "aws_instance",
      "mode": "managed",
      "action": "create"
    },
    {
      "isDrifted": false,
      "taskType": "post-plan",
      "dataType": "terraform",
      "providerName": "aws",
      "providerType": "aws",
      "providerVersion": "4.0.0"
    }
  ]
}

Get specific run status

get

Retrieves the status of a specific run within the workspace

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

workspaceIdstringRequired

Unique identifier of the workspace

runIdstringRequired

Unique identifier of the run

Responses

200

Run status retrieved successfully

application/json

statusstringOptional

Current status of the run (e.g., pending, running, completed, failed, etc)

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

403

Insufficient permissions

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

get

/runners/workspaces/{workspaceId}/run/{runId}/status

HTTPcURLJavaScriptPython

GET /runners/workspaces/{workspaceId}/run/{runId}/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "text"
}