---
title: "Scale a group."
method: POST
path: "/v1/groups/{name}/scale"
tags: ["groups"]
---

# Scale a group.

`POST /v1/groups/{name}/scale`

## Request

- Base URL: `https://api.smolmachines.com`
- URL: `https://api.smolmachines.com/v1/groups/{name}/scale`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/smolmachines/apis/smolfleet-api/docs/v1/groups/:name/scale/post.ts> (a function with typed inputs; its response is checked against the schema)

Changes the group's replica count; new instances are placed immediately. Requires the `group:write` scope (legacy alias `app:write`).

## Path parameters

- `name` string, required

## Request body

- ScaleRequest
  - `count` integer, required

## Response `200`

Scaled

- GroupInfo
  - `createdAt` string, required
  - `domain` string, nullable
  - `id` string, required
  - `image` string, required
  - `instances` InstanceInfo[], required
    - `generation` integer, required
    - `hostPort` integer, nullable
    - `id` string, required
    - `nodeId` string, required
    - `status` string, required
  - `name` string, required
  - `port` integer, required
  - `replicas` integer, required
  - `status` string, required
  - `updatedAt` string, required

## Other responses

- `401`: Missing or invalid API key
- `403`: Key lacks the required scope
- `404`: Not found
- `429`: Rate limited; retry after the Retry-After header
- `500`: Internal error

## Changes

- **2026-10-16** `bc31fc04a568`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smolmachines/apis/smolfleet-api/changes/v1/groups/:name/scale/post.md)

---

[API](https://skmtc.dev/smolmachines/apis/smolfleet-api.md) - [All operations](https://skmtc.dev/smolmachines/apis/smolfleet-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smolmachines/apis/smolfleet-api/revisions/bc31fc04a568?raw)