FIfirefly
Self-Hosted Runners

List runner pools

Retrieves all runner pools for the account

get/runners/runner-pools

Request

Query parameters

searchQuerystring

Search query

pageSizeinteger
offsetinteger

The offset of the items to return

statusPoolHealthStatus[]

Filter pools by health status

labelsstring[]

Filter pools by labels

field'name' | 'createdAt' | 'updatedAt' | 'runnersCount' | 'assignedProjectsCount' | 'assignedWorkspaceCount' | 'poolStatus'
direction'asc' | 'desc'

Sort criteria for runner pools

Response

Runner pools retrieved 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

Changes

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