---
title: "Deploy workspace"
method: POST
path: "/runners/workspaces/{workspaceId}"
tags: ["Runners Workspaces"]
---

# Deploy workspace

`POST /runners/workspaces/{workspaceId}`

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

## Path parameters

- `workspaceId` string, required

## Request body

- object
  - `taskType` 'plan' | 'apply', required — The type of task to run (plan or apply)
  - `vcs` object, required
    - `reference` string — The branch to deploy from
    - `type` 'branch' | 'tag' | 'commit'
  - `trigger` object, required — Trigger configuration for the deployment
    - `type` 'manual' | 'scheduled'
  - `cmdArguments` string — Additional command line arguments

## Response `200`

Workspace deployed successfully

- object
  - `status` integer
  - `data` object
    - `message` string

## Other responses

- `400` — Bad Request Error
- `401` — Unauthorized Error
- `403` — Insufficient permissions
- `404` — Not Found Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/firefly/apis/api-gateway.md) · [All operations](https://skmtc.net/firefly/apis/api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firefly/api-gateway/revisions/eea119b4113f/schema)