Self-Hosted Runners

Update a runner pool

Updates an existing runner pool

patch/runners/runner-pools/{poolId}

Request

Base URL
https://api.firefly.ai/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firefly/apis/api-gateway/docs/runners/runner-pools/:poolId/patch.ts
A function with typed inputs. Its response is checked against the schema.

poolIdstring required

Unique identifier of the runner pool

namestring

Name of the runner pool

labelsstring[]

Labels to assign to the runner pool

descriptionstring

Description of the runner pool

Runner pool updated successfully

idstring

Unique identifier for the runner pool

namestring

Name of the runner pool

accountIdstring

ID of the account the pool belongs to

labelsstring[]

Labels assigned to the runner pool

descriptionstring

Description of the runner pool

runnersCountinteger

Number of runners in the pool

assignedProjectsCountinteger

Number of projects assigned to this pool

assignedWorkspaceCountinteger

Number of workspaces assigned to this pool

createdAtstring date-time

Timestamp when the pool was created

updatedAtstring date-time

Timestamp when the pool was last updated

No recorded changes to this operation across all 1 revision of this API.