RunWhen runners API
The runners API from RunWhen — 2 operation(s) for runners.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/runwhen-runners-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: papi alert-query-proxy Runners API
description: RunWhen Platform API
version: 2.0.0
servers:
- url: https://papi.beta.runwhen.com
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: runners
paths:
/api/v3/runners:
get:
tags:
- runners
summary: List all runners
description: List all runners, ordered by id descending.
operationId: list_runners_api_v3_runners_get
parameters:
- name: limit
in: query
required: false
schema:
type: integer
maximum: 1000
minimum: 1
description: Maximum number of results
default: 100
title: Limit
description: Maximum number of results
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Number of results to skip
default: 0
title: Offset
description: Number of results to skip
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunnerListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- BearerAuth: []
/api/v3/runners/{runner_uuid}:
get:
tags:
- runners
summary: Get a runner by UUID
description: Get a single runner by its UUID.
operationId: get_runner_api_v3_runners__runner_uuid__get
parameters:
- name: runner_uuid
in: path
required: true
schema:
type: string
title: Runner Uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunnerResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- BearerAuth: []
components:
schemas:
RunnerResponse:
properties:
id:
type: integer
title: Id
description: Unique identifier
runner_uuid:
type: string
title: Runner Uuid
description: Stable UUID identifier for this runner
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Human-readable runner name
workspace_name:
anyOf:
- type: string
- type: 'null'
title: Workspace Name
description: Associated workspace name
last_heartbeat:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Heartbeat
description: Last heartbeat timestamp
created_at:
type: string
format: date-time
title: Created At
description: Creation timestamp
modified_at:
type: string
format: date-time
title: Modified At
description: Last modification timestamp
type: object
required:
- id
- runner_uuid
- created_at
- modified_at
title: RunnerResponse
description: Runner response schema for API responses.
RunnerListResponse:
properties:
count:
type: integer
title: Count
description: Total count of runners
next:
anyOf:
- type: string
- type: 'null'
title: Next
description: URL to next page
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
description: URL to previous page
results:
items:
$ref: '#/components/schemas/RunnerResponse'
type: array
title: Results
description: List of runners
type: object
required:
- count
- results
title: RunnerListResponse
description: DRF-style paginated response for Runner list endpoint.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT access token from /api/v3/token/ or Auth0 login