Skip to content
SupaCloud Docs
Select themeSelect language

`POST /api/workspaces/{id}/worker-groups` — create a workspace-owned group (workspace admin). Audited (`worker_group_created`).

POST
/api/workspaces/{id}/worker-groups
curl --request POST \
  --url https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/worker-groups \
  --header 'Content-Type: application/json' \
  --cookie supacloud_session=<supacloud_session> \
  --data '{ "description": "example", "labels": [ "example" ], "name": "example", "slug": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Workspace ID

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Request body to create or update a worker group. slug is a lower-kebab handle unique within the workspace scope; labels is the AND-set a runner must advertise to serve the group ([] = a name-only convenience group every online runner serves).

object
description

Optional free-form description.

string | null
labels

The AND-set of dispatch labels a runner must advertise to serve this group.

Array<string>
name
required

Human-readable name.

string
slug
required

Lower-kebab handle, unique within the workspace.

string
Examplegenerated
{
  "description": "example",
  "labels": [
    "example"
  ],
  "name": "example",
  "slug": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The created worker group

Media typeapplication/json

A worker_groups row. workspace_id = NULL is an instance-global group (system-admin), usable by any workspace’s bindings. FromRow auto-maps from SELECT *. The labels are the AND-set a runner must advertise to serve this group; a required group contributes its labels into a task’s flat required_labels.

object
created_at
required
string format: date-time
created_by
string | null format: uuid
description
string | null
id
required
string format: uuid
labels
required

The AND-set of dispatch labels a runner must advertise to serve this group.

Array<string>
name
required
string
slug
required
string
updated_at
required
string format: date-time
workspace_id

Owning workspace; None = instance-global.

string | null format: uuid
Examplegenerated
{
  "created_at": "2026-04-15T12:00:00Z",
  "created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "description": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "labels": [
    "example"
  ],
  "name": "example",
  "slug": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Section titled “400”

Invalid name/slug

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}