How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Runners API

The Runners API from GitHub — 16 operation(s) for runners.

GitHub Runners API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Runners. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 31 operations across 16 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

31 operations 16 paths 13 schemas 9 DELETE12 GET1 PATCH3 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Runners API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 31

Across 16 paths, the API surfaces 31 operations — 9 DELETE, 12 GET, 1 PATCH, 3 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Runners 31
GET
/orgs/{org}/actions/runner-groups
GitHub List Self-hosted Runner Groups for an Organization
listSelfhostedRunnerGroupsForAnOrganization 4 params → 200
POST
/orgs/{org}/actions/runner-groups
GitHub Create Self-hosted Runner Group for an Organization
createSelfhostedRunnerGroupForAnOrganization 1 param body → 201
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Get Self-hosted Runner Group for an Organization
getSelfhostedRunnerGroupForAnOrganization 2 params → 200
PATCH
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Update Self-hosted Runner Group for an Organization
updateSelfhostedRunnerGroupForAnOrganization 2 params body → 200
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Delete Self-hosted Runner Group from an Organization
deleteSelfhostedRunnerGroupFromAnOrganization 2 params → 204
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub List Repository Access to Self-hosted Runner Group in an Organization
listRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 4 params → 200
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub Set Repository Access for Self-hosted Runner Group in an Organization
setRepositoryAccessForSelfhostedRunnerGroupInAnOrganization 2 params body → 204
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Add Repository Access to Self-hosted Runner Group in an Organization
addRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 3 params → 204
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Remove Repository Access to Self-hosted Runner Group in an Organization
removeRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 3 params → 204
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
GitHub List Self-hosted Runners in Group for an Organization
listSelfhostedRunnersInGroupForAnOrganization 4 params → 200
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
GitHub Set Self-hosted Runners in Group for an Organization
setSelfhostedRunnersInGroupForAnOrganization 2 params body → 204
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
GitHub Add Self-hosted Runner to Group for an Organization
addSelfhostedRunnerToGroupForAnOrganization 3 params → 204
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
GitHub Remove Self-hosted Runner from Group for an Organization
removeSelfhostedRunnerFromGroupForAnOrganization 3 params → 204
GET
/orgs/{org}/actions/runners
GitHub List Self-hosted Runners for an Organization
listSelfhostedRunnersForAnOrganization 3 params → 200
GET
/orgs/{org}/actions/runners/downloads
GitHub List Runner Applications for an Organization
listRunnerApplicationsForAnOrganization 1 param → 200
GET
/orgs/{org}/actions/runners/{runner_id}
GitHub Get Self-hosted Runner for an Organization
getSelfhostedRunnerForAnOrganization 2 params → 200
DELETE
/orgs/{org}/actions/runners/{runner_id}
GitHub Delete Self-hosted Runner from an Organization
deleteSelfhostedRunnerFromAnOrganization 2 params → 204
GET
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub List Labels for Self-hosted Runner for an Organization
listLabelsForSelfhostedRunnerForAnOrganization 2 params → 200404
POST
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub Add Custom Labels to Self-hosted Runner for an Organization
addCustomLabelsToSelfhostedRunnerForAnOrganization 2 params body → 200404422
PUT
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub Set Custom Labels for Self-hosted Runner for an Organization
setCustomLabelsForSelfhostedRunnerForAnOrganization 2 params body → 200404422
DELETE
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub Remove All Custom Labels from Self-hosted Runner for an Organization
removeAllCustomLabelsFromSelfhostedRunnerForAnOrganization 2 params → 200404
DELETE
/orgs/{org}/actions/runners/{runner_id}/labels/{name}
GitHub Remove Custom Label from Self-hosted Runner for an Organization
removeCustomLabelFromSelfhostedRunnerForAnOrganization 3 params → 200404422
GET
/repos/{owner}/{repo}/actions/runners
GitHub List Self-hosted Runners for Repository
listSelfhostedRunnersForRepository 7 params → 200
GET
/repos/{owner}/{repo}/actions/runners/downloads
GitHub List Runner Applications for Repository
listRunnerApplicationsForRepository 5 params → 200
GET
/repos/{owner}/{repo}/actions/runners/{runner_id}
GitHub Get Self-hosted Runner for Repository
getSelfhostedRunnerForRepository 6 params → 200
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}
GitHub Delete Self-hosted Runner from Repository
deleteSelfhostedRunnerFromRepository 6 params → 204
GET
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub List Labels for Self-hosted Runner for Repository
listLabelsForSelfhostedRunnerForRepository 6 params → 200404
POST
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub Add Custom Labels to Self-hosted Runner for Repository
addCustomLabelsToSelfhostedRunnerForRepository 6 params body → 200404422
PUT
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub Set Custom Labels for Self-hosted Runner for Repository
setCustomLabelsForSelfhostedRunnerForRepository 6 params body → 200404422
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub Remove All Custom Labels from Self-hosted Runner for Repository
removeAllCustomLabelsFromSelfhostedRunnerForRepository 6 params → 200404
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}
GitHub Remove Custom Label from Self-hosted Runner for Repository
removeCustomLabelFromSelfhostedRunnerForRepository 7 params → 200404422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are minimal-repository (87 properties), simple-user (21 properties), runner-groups-org (12 properties), runner (7 properties). Each schema is shown below with its type and property counts.

validation-error-simple
object
Validation Error Simple
3 properties 2 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
runner-groups-org
object
12 properties 7 required
security-and-analysis
objectnull
3 properties
simple-user
object
A GitHub user.
21 properties 18 required
basic-error
object
Basic Error
4 properties
runner
object
A self hosted runner
7 properties 6 required
runner-label
object
A label for a self hosted runner
3 properties 1 required
runner-application
object
Runner Application
6 properties 4 required
runner_2
object
self hosted runner
7 properties 6 required
runner-label_2
object
label for a self hosted runner
3 properties 1 required
runner-application_2
object
Runner Application
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-runners-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Runners API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.