Skip to main content
POST
Create a CI runner

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 runner, up to 64 characters.

Required string length: 1 - 64
installationId
integer
required

ID of the Brimble GitHub App installation on the organization. See GET /v1/accounts/{git}.

Required range: x >= 1
mode
enum<string>
required

reuse runs jobs on sandboxes you attach, which stay running between jobs. per_job starts a new sandbox for each job and destroys it when the job ends.

Available options:
reuse,
per_job
teamId
string

Team to act in. Omit for your personal workspace.

Pattern: ^[a-fA-F0-9]{24}$
size
string

Sandbox size for each job, for example sbx.small. Required when mode is per_job.

region
string

ID of the sandbox region to run jobs in. Required when mode is per_job.

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

Most sandboxes to run at once in per_job mode. Defaults to 2.

Required range: 1 <= x <= 20

Response

CI runner created

message
string
required

Human-readable result of the request.

Example:

"CI runner created"

data
object
required
Last modified on November 10, 2026