Runners Workspaces

Deploy workspace

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

post/runners/workspaces/{workspaceId}

Request

Base URL
https://api.firefly.ai/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firefly/apis/api-gateway/docs/runners/workspaces/:workspaceId/post.ts
A function with typed inputs. Its response is checked against the schema.

workspaceIdstring required

Unique identifier of the workspace

taskType'plan' | 'apply' required

The type of task to run (plan or apply)

cmdArgumentsstring

Additional command line arguments

Workspace deployed successfully

statusinteger

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

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