Skip to main content

List Agent Runners

GET 
/api/automation/runners

List registered agent runners - machines that poll for agent jobs and do the work an Agent task step hands off. Paginated.

Required scope: settings:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Requires the workflows.index permission.

Filters

  • filter[search] - matches id (exact), name or hostname (partial).
  • filter[status] - online, offline or revoked; comma-separate for several. A runner is online when it was seen in the last 90 seconds.
  • filter[archived] - omitted/empty (default) returns active runners only, only returns revoked runners, all returns both.
  • Column filters filter[<column>.<operator>] on: id (numeric operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty), name, hostname, mode (text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty), created_at, last_seen_at (date operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days). The bare key (e.g. filter[name]) is also accepted. between takes two comma-separated values.
  • filter_groups - base64-encoded JSON filter tree combining the column filters above with AND/OR, e.g. {"conjunction":"and","children":[{"type":"condition","condition":{"column":"name","operator":"contains","value":"mac"}},{"type":"group","group":{"conjunction":"or","children":[...]}}]}.

Sorting: sort - one of id, name, mode, last_seen_at, created_at; prefix with - for descending. Default -id.

Pagination: page, per_page (default 10).

Response fields: mode is attended (a person confirms each job on the machine) or unattended. status is online / offline / revoked. templates are the job templates the runner last advertised. jobs7d is the number of jobs assigned in the last 7 days. The runner token is never returned here.

Request​

Responses​

OK

Response Headers
    Content-Type