GitHub Actions 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 Actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.
This API exposes
137 operations
across 85 paths,
and defines 53 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}.
137 operations85 paths53 schemas23 DELETE66 GET6 PATCH16 POST26 PUT
Metadata
The identity and technical contract details declared by the specification.
GitHub Actions API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerHttpAuthentication).
bearerHttpAuthentication — Bearer Token
Paths & Operations 137
Across 85 paths, the API surfaces 137 operations — 23 DELETE, 66 GET, 6 PATCH, 16 POST, 26 PUT. Each is listed below with its method, path, parameters, and response codes.
Actions 137
Endpoints to manage GitHub Actions using the REST API.
GET
/enterprises/{enterprise}/actions/cache/usage
GitHub Get GitHub Actions Cache Usage for an Enterprise
The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), minimal-repository (87 properties), workflow-run (36 properties), job (23 properties). Each schema is shown below with its type and property counts.
workflow-run
object
An invocation of a workflow
36 properties26 required
actions-secret
object
Set secrets for GitHub Actions.
3 properties3 required
allowed-actions
string
The permissions policy that controls the actions that are allowed to run.
actions-organization-permissions
object
4 properties1 required
selected-actions
object
2 properties2 required
runner
object
A self hosted runner
7 properties6 required
runner-label
object
A label for a self hosted runner
3 properties1 required
environment-approvals
object
An entry in the reviews log for environment deployments
4 properties4 required
actions-workflow-access-to-repository
object
1 property1 required
pull-request-minimal
object
5 properties5 required
actions-cache-usage-by-repository
object
GitHub Actions Cache Usage by repository.
3 properties3 required
nullable-simple-user
objectnull
A GitHub user.
21 properties18 required
authentication-token
object
Authentication Token
6 properties2 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties11 required
actions-enabled
boolean
Whether GitHub Actions is enabled on the repository.
runner-groups-org
object
12 properties7 required
scim-error
object
Scim Error
6 properties
actions-can-approve-pull-request-reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
deployment-reviewer-type
string
The type of reviewer.
organization-actions-variable
object
Organization variable for GitHub Actions.
6 properties5 required
actions-cache-list
object
Repository actions caches
2 properties2 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties10 required
empty-object
object
An object without any properties.
nullable-simple-commit
objectnull
A commit.
6 properties6 required
actions-cache-usage-policy-enterprise
object
GitHub Actions cache usage policy for an enterprise.
2 properties
nullable-license-simple
objectnull
License Simple
6 properties5 required
actions-set-default-workflow-permissions
object
2 properties
pending-deployment
object
Details of a deployment that is waiting for protection rules to pass
5 properties5 required
actions-public-key
object
The public key used for setting Actions Secrets.
6 properties2 required
actions-get-default-workflow-permissions
object
2 properties2 required
code-of-conduct
object
Code Of Conduct
5 properties4 required
minimal-repository
object
Minimal Repository
87 properties46 required
security-and-analysis
objectnull
3 properties
actions-default-workflow-permissions
string
The default workflow permissions granted to the GITHUBTOKEN when running workflows.
referenced-workflow
object
A workflow referenced/reused by the initial caller workflow
3 properties2 required
enabled-repositories
string
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
workflow
object
A GitHub Actions workflow
11 properties10 required
actions-repository-permissions
object
3 properties1 required
job
object
Information of a job execution in a workflow run
23 properties21 required
actions-cache-usage-org-enterprise
object
2 properties2 required
deployment
object
A request for a specific ref(branch,sha,tag) to be deployed
18 properties14 required
runner-application
object
Runner Application
6 properties4 required
actions-cache-usage-policy-for-repository
object
GitHub Actions cache usage policy for repository.
1 property1 required
oidc-custom-sub-repo
object
Actions OIDC subject customization for a repository
2 properties1 required
validation-error-simple
object
Validation Error Simple
3 properties2 required
organization-actions-secret
object
Secrets for GitHub Actions for an organization.
5 properties4 required
simple-user
object
A GitHub user.
21 properties18 required
nullable-integration
objectnull
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties11 required
repository
object
A repository on GitHub.
95 properties73 required
basic-error
object
Basic Error
4 properties
selected-actions-url
string
The API URL to use to get or set the actions that are allowed to run, when allowedactions is set to selected.
actions-variable
object
4 properties4 required
artifact
object
An artifact
11 properties10 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of GitHub Actions 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.