Skip to main content
POST
Create an autoscaling rule

Authorizations

x-brimble-key
string
header
required

API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.

Body

application/json
name
string
required

Name of the autoscaling group.

active
boolean
required

true scales between min_containers and max_containers; false runs a fixed number of replicas.

replicas
integer

Fixed number of instances, 1 to 8. Required when active is false.

Required range: 1 <= x <= 8
min_containers
integer

Fewest instances to run, at least 1. Required when active is true.

Required range: x >= 1
team_id
string

Team to act in. Omit for your personal workspace.

Pattern: ^[a-fA-F0-9]{24}$
max_containers
integer

Most instances to run. Must be greater than min_containers. Required when active is true.

Required range: x >= 1
meta
object

Free-form metadata to store with the group.

max_memory
integer

Average memory usage, as a percentage (at least 30), above which another instance is added. Required when active is true.

Required range: x >= 30
max_cpu
integer

Average CPU usage, as a percentage (at least 30), above which another instance is added. Required when active is true.

Required range: x >= 30

Response

Autoscaling group created successfully

message
string
required

Human-readable result of the request.

Example:

"Autoscaling group created successfully"

data
object
required
Last modified on October 11, 2026