---
title: "Create workspace runner"
method: POST
path: "/workspaces/{workspace}/pipelines-config/runners"
tags: ["Pipelines"]
---

# Create workspace runner

`POST /workspaces/{workspace}/pipelines-config/runners`

Create workspace runner.

## Path parameters

- `workspace` string, required

## Response `200`

The workspace runner.

- PipelineRunner — A Bitbucket Pipelines runner for self-hosted builds.
  - `type` string, required
  - `uuid` string — The UUID identifying the runner.
  - `name` string — The name of the runner.
  - `labels` string[] — Labels assigned to the runner for identification and routing.
  - `state` PipelineRunnerState — The state information of a runner.
    - `type` string, required
    - `status` 'UNREGISTERED' | 'ONLINE' | 'OFFLINE' | 'DISABLED' | 'ENABLED' | 'UNHEALTHY' — The current status of the runner.
    - `version` PipelineRunnerVersion — Version information for a runner.
      - `type` string, required
      - `version` string — The currently installed version of the runner.
      - `current` string — The current recommended version of the runner.
    - `updated_on` string, date-time — The timestamp when the runner state was last updated.
    - `cordoned` boolean — Whether the runner is cordoned (prevented from accepting new steps).
  - `created_on` string, date-time — The timestamp when the runner was created.
  - `updated_on` string, date-time — The timestamp when the runner was last updated.
  - `oauth_client` PipelineRunnerOauthClient — OAuth client configuration for runner authentication.
    - `type` string, required
    - `id` string — The OAuth client ID.
    - `secret` string — The OAuth client secret. This is an optional element that is only provided once.
    - `token_endpoint` string, uri — The OAuth token endpoint URL.
    - `audience` string — The intended audience for the OAuth token.

## Other responses

- `400` — The request body contained invalid properties or runner limit exceeded.
- `409` — The workspace runner with the provided UUID already exists.

---

[API](https://skmtc.net/atlassian/apis/bitbucket-api.md) · [All operations](https://skmtc.net/atlassian/apis/bitbucket-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/bitbucket-api/versions/1ba0a3efd864/schema)