latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Self-Hosted Runners

Search runner pools

Search runner pools with advanced filtering, sorting, and text search

post/runners/runner-pools/search

Query parameters

pageSizeinteger
offsetinteger

The offset of the items to return

Request body

textstring

Free text search query, searches across pool name and labels

Example request

{
  "sort": [
    {
      "field": "runnersCount",
      "direction": "desc"
    }
  ]
}

Response

Runner pools matching search criteria 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