GitHub Actions website screenshot

GitHub Actions

APIs for GitHub Actions - automation and CI/CD platform.

GitHub Actions publishes 11 APIs on the APIs.io network, including Artifacts API, Cache API, Jobs API, and 8 more.

The GitHub Actions catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

GitHub Actions’ developer surface includes authentication, engineering blog, changelog, getting-started guide, support, pricing, developer portal, and 63 more developer resources.

🌐 Visit website 📡 Source on GitHub
78.7/100 exemplar ▬ flat Agent 58/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreemiumSelf serve⚡ Free to try
11 APIs 1 MCP Servers 10 Features 6 Use Cases

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 78.7/100 · exemplar
Contract Quality 18.2 / 25
Developer Ergonomics 16.1 / 20
Commercial Clarity 18.4 / 20
Operational Transparency 10.3 / 13
Governance 8.4 / 12
Discoverability 7.4 / 10
Agent readiness — 58/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 12 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 4 / 4
Consent & Bot Identity 3 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/github-actions: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 11

Individual APIs this provider publishes, each with its own machine-readable definition.

GitHub Actions Artifacts API

Download and manage workflow run artifacts

GitHub Actions Cache API

Manage workflow dependency caches

GitHub Actions Jobs API

Access information about workflow jobs

GitHub Actions OIDC API

Manage OIDC subject claim customization

GitHub Actions Permissions API

Control Actions enablement and permissions

GitHub Actions Secrets API

Manage encrypted secrets for Actions

GitHub Actions Self-Hosted Runner Groups API

Manage runner groups for organizations

GitHub Actions Self-Hosted Runners API

Manage self-hosted runners for workflows

GitHub Actions Variables API

Create and manage workflow variables

GitHub Actions Workflow Runs API

Manage and monitor workflow run executions

GitHub Actions Workflows API

Manage workflow files and workflow runs

Scroll for all 11

Postman Collections 1

Ready-to-run Postman collections for exercising this provider's APIs.

GitHub Actions API

POSTMAN

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

GitHub Actions API

OPEN COLLECTION

Arazzo Workflows 12

Multi-step API workflows described with the Arazzo specification.

_Index

ARAZZO

GitHub Actions Approve a Pending Deployment

Get a run, find its pending deployment environments, approve them, then poll the run to completion.

ARAZZO

GitHub Actions Cancel a Workflow Run and Confirm

Get a run, request cancellation, poll until it is no longer in progress, and force-cancel if it gets stuck.

ARAZZO

GitHub Actions Collect Workflow Run Artifacts

Find the latest run for a repository, confirm it, list its artifacts, and resolve a download URL.

ARAZZO

GitHub Actions Dispatch and Track a Workflow Run

Manually dispatch a workflow, find the run it created, poll until it completes, then list its jobs.

ARAZZO

GitHub Actions Inspect Failed Job Logs

Find the latest failed run, list its jobs, get the failing job, and resolve its log download URL.

ARAZZO

GitHub Actions Prune Repository Caches

Read cache usage, list the largest caches, and delete the largest one by id to reclaim space.

ARAZZO

GitHub Actions Register a Self-hosted Runner

List the available runner application binaries, mint a registration token, then list the repository's runners.

ARAZZO

GitHub Actions Re-run Failed Jobs and Track

Find the most recent failed run, re-run only its failed jobs, and poll the run until it completes again.

ARAZZO

GitHub Actions Share an Organization Secret with Selected Repositories

Fetch the org public key, create or update a selected-visibility org secret, scope it to repositories, and list them.

ARAZZO

GitHub Actions Upsert a Repository Secret

Fetch the repository public key, create or update an encrypted secret, then confirm it exists.

ARAZZO

GitHub Actions Upsert a Repository Variable

Look up a repository variable by name and either create it or update it, then read it back.

ARAZZO

Scroll for all 12

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

github-actions-mcp.yml

MCP SERVER

Pricing Plans 1

Published pricing tiers and plan structures.

Github Actions Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Github Actions Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Github Actions Finops

FINOPS

Features 10

Notable capabilities this provider offers.

Automated CI/CD workflows triggered by repository events
Matrix builds across multiple OS and language versions
Reusable workflows and composite actions
Encrypted secrets and variables at repo, org, and environment scopes
Self-hosted and GitHub-hosted runner management
Workflow artifact storage and sharing
Deployment protection rules and environment approvals
OIDC integration for cloud provider authentication
Dependency caching for faster builds
Runner groups for organizational access control

Scroll for all 10

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Github Actions Context

0 classes · 0 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

GitHub Actions API Rules

5 rules · 4 warnings 1 info

SPECTRAL

GitHub Actions API Rules

15 rules · 8 errors 7 warnings

SPECTRAL

JSON Schema 34

Standalone JSON Schema definitions for this provider's data models.

ActionsCacheEntry

7 properties

JSON SCHEMA

ActionsCacheUsage

3 properties

JSON SCHEMA

ActionsDefaultWorkflowPermissions

2 properties

JSON SCHEMA

ActionsOrganizationPermissions

4 properties

JSON SCHEMA

ActionsPublicKey

2 properties

JSON SCHEMA

ActionsRepositoryPermissions

3 properties

JSON SCHEMA

ActionsSecret

3 properties

JSON SCHEMA

ActionsVariable

4 properties

JSON SCHEMA

Artifact

11 properties

JSON SCHEMA

AuthenticationToken

2 properties

JSON SCHEMA

GitHub Actions Cache Entry

7 properties

JSON SCHEMA

Deployment

8 properties

JSON SCHEMA

EnvironmentApproval

3 properties

JSON SCHEMA

Job

21 properties

JSON SCHEMA

JobStep

6 properties

JSON SCHEMA

MinimalRepository

8 properties

JSON SCHEMA

OidcCustomSubOrg

1 properties

JSON SCHEMA

OidcCustomSub

2 properties

JSON SCHEMA

OrgActionsSecret

5 properties

JSON SCHEMA

PendingDeployment

5 properties

JSON SCHEMA

GitHub Actions Workflow Run

27 properties

JSON SCHEMA

RunnerApplication

6 properties

JSON SCHEMA

RunnerGroup

7 properties

JSON SCHEMA

RunnerLabel

3 properties

JSON SCHEMA

GitHub Actions Self-Hosted Runner

6 properties

JSON SCHEMA

GitHub Actions Secret

5 properties

JSON SCHEMA

SelfHostedRunner

6 properties

JSON SCHEMA

SimpleCommit

6 properties

JSON SCHEMA

SimpleUser

7 properties

JSON SCHEMA

GitHub Actions Variable

4 properties

JSON SCHEMA

WorkflowRun

24 properties

JSON SCHEMA

WorkflowRunUsage

2 properties

JSON SCHEMA

Workflow

10 properties

JSON SCHEMA

WorkflowUsage

1 properties

JSON SCHEMA

Scroll for all 34

JSON Structure 29

JSON Structure definitions describing this provider's data shapes.

Github Actions Actions Cache Entry Structure

7 properties

JSON STRUCTURE

Github Actions Actions Cache Usage Structure

3 properties

JSON STRUCTURE

Github Actions Actions Default Workflow Permissions Structure

2 properties

JSON STRUCTURE

Github Actions Actions Organization Permissions Structure

4 properties

JSON STRUCTURE

Github Actions Actions Public Key Structure

2 properties

JSON STRUCTURE

Github Actions Actions Repository Permissions Structure

3 properties

JSON STRUCTURE

Github Actions Actions Secret Structure

3 properties

JSON STRUCTURE

Github Actions Actions Variable Structure

4 properties

JSON STRUCTURE

Github Actions Artifact Structure

11 properties

JSON STRUCTURE

Github Actions Authentication Token Structure

2 properties

JSON STRUCTURE

Github Actions Deployment Structure

8 properties

JSON STRUCTURE

Github Actions Environment Approval Structure

3 properties

JSON STRUCTURE

Github Actions Job Step Structure

6 properties

JSON STRUCTURE

Github Actions Job Structure

21 properties

JSON STRUCTURE

Github Actions Minimal Repository Structure

8 properties

JSON STRUCTURE

Github Actions Oidc Custom Sub Org Structure

1 properties

JSON STRUCTURE

Github Actions Oidc Custom Sub Structure

2 properties

JSON STRUCTURE

Github Actions Org Actions Secret Structure

5 properties

JSON STRUCTURE

Github Actions Pending Deployment Structure

5 properties

JSON STRUCTURE

Github Actions Runner Application Structure

6 properties

JSON STRUCTURE

Github Actions Runner Group Structure

7 properties

JSON STRUCTURE

Github Actions Runner Label Structure

3 properties

JSON STRUCTURE

Github Actions Self Hosted Runner Structure

6 properties

JSON STRUCTURE

Github Actions Simple Commit Structure

6 properties

JSON STRUCTURE

Github Actions Simple User Structure

7 properties

JSON STRUCTURE

Github Actions Workflow Run Structure

24 properties

JSON STRUCTURE

Github Actions Workflow Run Usage Structure

2 properties

JSON STRUCTURE

Github Actions Workflow Structure

10 properties

JSON STRUCTURE

Github Actions Workflow Usage Structure

1 properties

JSON STRUCTURE

Scroll for all 29

Examples 29

Example request and response payloads for these APIs.

Github Actions Actions Cache Entry Example

7 fields

EXAMPLE

Github Actions Actions Cache Usage Example

3 fields

EXAMPLE

Github Actions Actions Default Workflow Permissions Example

2 fields

EXAMPLE

Github Actions Actions Organization Permissions Example

4 fields

EXAMPLE

Github Actions Actions Public Key Example

2 fields

EXAMPLE

Github Actions Actions Repository Permissions Example

3 fields

EXAMPLE

Github Actions Actions Secret Example

3 fields

EXAMPLE

Github Actions Actions Variable Example

4 fields

EXAMPLE

Github Actions Artifact Example

11 fields

EXAMPLE

Github Actions Authentication Token Example

2 fields

EXAMPLE

Github Actions Deployment Example

8 fields

EXAMPLE

Github Actions Environment Approval Example

3 fields

EXAMPLE

Github Actions Job Example

21 fields

EXAMPLE

Github Actions Job Step Example

6 fields

EXAMPLE

Github Actions Minimal Repository Example

8 fields

EXAMPLE

Github Actions Oidc Custom Sub Example

2 fields

EXAMPLE

Github Actions Oidc Custom Sub Org Example

1 fields

EXAMPLE

Github Actions Org Actions Secret Example

5 fields

EXAMPLE

Github Actions Pending Deployment Example

5 fields

EXAMPLE

Github Actions Runner Application Example

6 fields

EXAMPLE

Github Actions Runner Group Example

7 fields

EXAMPLE

Github Actions Runner Label Example

3 fields

EXAMPLE

Github Actions Self Hosted Runner Example

6 fields

EXAMPLE

Github Actions Simple Commit Example

6 fields

EXAMPLE

Github Actions Simple User Example

7 fields

EXAMPLE

Github Actions Workflow Example

10 fields

EXAMPLE

Github Actions Workflow Run Example

24 fields

EXAMPLE

Github Actions Workflow Run Usage Example

2 fields

EXAMPLE

Github Actions Workflow Usage Example

1 fields

EXAMPLE

Scroll for all 29

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Github Actions Authentication

http · 2 schemes

SECURITY

Github Actions Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Github Actions Vulnerability Disclosure

Hackerone · security.txt · contact published

SECURITY

Github Actions Trust Center

SOC 1 Type 2, SOC 2 Type 2, SOC 3, ISO/IEC 27001:2013, ISO/IEC 42001:2023, CSA STAR Level 2, FedRAMP LI-SaaS (ATO)

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Github Actions Scopes

OAuth 2.0 · no documented scopes

0 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Github Actions Agentic Access

82 operations · 39 acting · 2 human-in-the-loop

82 operations · 39 acting

AGENTIC

Use Cases 6

What developers build with this provider.

Continuous integration and testing on every push or pull request
Automated deployment to cloud environments
Scheduled maintenance and cleanup workflows
Building and publishing container images
Automated code quality and security scanning
Release management and artifact publishing

Integrations 8

Pre-built integrations with other platforms and tools.

AWS (via OIDC)
Azure (via OIDC)
Google Cloud (via OIDC)
Docker Hub
npm
PyPI
Slack
Jira

Scroll for all 8

Resources

Get Started 6

Portal, sign-up, and the first successful call

GettingStarted
GettingStarted
 Portal
Portal
 Signup
Signup
 Login
Login
 DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted

Documentation 10

Reference material describing how the API behaves

Documentation
Documentation
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema

Scroll for all 10

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess
 LlmsText
LlmsText
 LLMsTxt
LLMsTxt
 WellKnown
WellKnown
 MCPServer
MCPServer

Design & Contract 17

Pagination, idempotency, versioning, errors, and events

Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 JSONLD
JSONLD
 Conformance
Conformance
 ErrorCatalog
ErrorCatalog
 Lifecycle
Lifecycle
 Conventions
Conventions
 DataModel
DataModel

Scroll for all 17

Build 9

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace
PostmanWorkspace
 GitHubOrganization
GitHubOrganization
 JavaScript SDK
SDKs
 Ruby SDK
SDKs
 .NET SDK
SDKs
 Go SDK
SDKs
 CLI
CLI
 Packages
Packages
 CLI
CLI

Scroll for all 9

Access & Security 8

Authentication, authorization, and security posture

Authentication
Authentication
 Authentication
Authentication
 Security
Security
 SecurityTxt
SecurityTxt
 OAuthScopes
OAuthScopes
 DomainSecurity
DomainSecurity
 VulnerabilityDisclosure
VulnerabilityDisclosure
 TrustCenter
TrustCenter

Scroll for all 8

Learn 1

Tutorials, courses, talks, and written guidance

YouTube
YouTube

Operate 6

Status, limits, changes, and where to get help

RateLimits
RateLimits
 StatusPage
StatusPage
 ChangeLog
ChangeLog
 Support
Support
 StackOverflow
StackOverflow
 ChangeLog
ChangeLog

Commercial 3

Pricing, plans, and the legal terms of use

TermsOfService
TermsOfService
 PrivacyPolicy
PrivacyPolicy
 Pricing
Pricing

Company 1

The organization behind the API

Blog
Blog

Other 4

Properties that don't map to a standard resource type

Marketplace
Marketplace
 CI/CD Automation Capability
Capabilities
 Actions API Shared Definition
Capabilities
 Overlay
Overlay

Source (apis.yml)

apis.yml Raw ↑ 
name: GitHub Actions
description: APIs for GitHub Actions - automation and CI/CD platform.
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png
url: https://docs.github.com/en/rest/actions
created: '2024'
modified: '2026-06-20'
specificationVersion: '0.18'
apis:
- aid: github-actions:github-actions-artifacts-api
  name: GitHub Actions Artifacts API
  description: Download and manage workflow run artifacts
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Artifacts
  properties:
  - type: OpenAPI
    url: openapi/github-actions-artifacts-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-cache-api
  name: GitHub Actions Cache API
  description: Manage workflow dependency caches
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Cache
  properties:
  - type: OpenAPI
    url: openapi/github-actions-cache-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-jobs-api
  name: GitHub Actions Jobs API
  description: Access information about workflow jobs
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Jobs
  properties:
  - type: OpenAPI
    url: openapi/github-actions-jobs-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-oidc-api
  name: GitHub Actions OIDC API
  description: Manage OIDC subject claim customization
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - OIDC
  properties:
  - type: OpenAPI
    url: openapi/github-actions-oidc-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-permissions-api
  name: GitHub Actions Permissions API
  description: Control Actions enablement and permissions
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Permissions
  properties:
  - type: OpenAPI
    url: openapi/github-actions-permissions-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-secrets-api
  name: GitHub Actions Secrets API
  description: Manage encrypted secrets for Actions
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Secrets
  properties:
  - type: OpenAPI
    url: openapi/github-actions-secrets-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-self-hosted-runner-groups-api
  name: GitHub Actions Self-Hosted Runner Groups API
  description: Manage runner groups for organizations
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Self-Hosted Runner Groups
  properties:
  - type: OpenAPI
    url: openapi/github-actions-self-hosted-runner-groups-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-self-hosted-runners-api
  name: GitHub Actions Self-Hosted Runners API
  description: Manage self-hosted runners for workflows
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Self-Hosted Runners
  properties:
  - type: OpenAPI
    url: openapi/github-actions-self-hosted-runners-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-variables-api
  name: GitHub Actions Variables API
  description: Create and manage workflow variables
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Variables
  properties:
  - type: OpenAPI
    url: openapi/github-actions-variables-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-workflow-runs-api
  name: GitHub Actions Workflow Runs API
  description: Manage and monitor workflow run executions
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Workflow Runs
  properties:
  - type: OpenAPI
    url: openapi/github-actions-workflow-runs-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
- aid: github-actions:github-actions-workflows-api
  name: GitHub Actions Workflows API
  description: Manage workflow files and workflow runs
  humanURL: https://docs.github.com/en/actions
  baseURL: https://api.github.com
  tags:
  - Workflows
  properties:
  - type: OpenAPI
    url: openapi/github-actions-workflows-api-openapi.yml
  - type: Documentation
    url: https://docs.github.com/en/rest/actions
  - type: Authentication
    url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
  - type: GettingStarted
    url: https://docs.github.com/en/actions/get-started/quickstart
  - type: APIReference
    url: https://docs.github.com/en/rest/actions
  - type: ChangeLog
    url: https://github.blog/changelog/label/actions/
  - type: SDKs
    url: https://github.com/octokit/octokit.js
  - type: SDKs
    url: https://github.com/octokit/octokit.rb
  - type: SDKs
    url: https://github.com/octokit/octokit.net
  - type: SDKs
    url: https://github.com/google/go-github
  - type: CLI
    url: https://cli.github.com/manual/gh_workflow_run
  - type: RateLimits
    url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
  - type: JSONSchema
    url: json-schema/github-actions-workflow-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-run-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-job-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-artifact-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-secret-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-runner-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-variable-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-cache-schema.json
  - type: JSONSchema
    url: json-schema/github-actions-simple-user-schema.json
  - type: JSONLD
    url: json-ld/github-actions-context.jsonld
maintainers:
- type: GitHub
  name: GitHub, Inc.
  url: https://github.com
  email: support@github.com
- FN: Kin Lane
  email: kin@apievangelist.com
common:
- type: AgenticAccess
  url: agentic-access/github-actions-agentic-access.yml
- type: Authentication
  url: authentication/github-actions-authentication.yml
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/github-actions/overview
- type: Arazzo
  url: arazzo/github-actions-approve-pending-deployment-workflow.yml
  name: GitHub Actions Approve a Pending Deployment
- type: Arazzo
  url: arazzo/github-actions-cancel-run-workflow.yml
  name: GitHub Actions Cancel a Workflow Run and Confirm
- type: Arazzo
  url: arazzo/github-actions-collect-run-artifacts-workflow.yml
  name: GitHub Actions Collect Workflow Run Artifacts
- type: Arazzo
  url: arazzo/github-actions-dispatch-and-track-run-workflow.yml
  name: GitHub Actions Dispatch and Track a Workflow Run
- type: Arazzo
  url: arazzo/github-actions-inspect-failed-job-logs-workflow.yml
  name: GitHub Actions Inspect Failed Job Logs
- type: Arazzo
  url: arazzo/github-actions-prune-repo-caches-workflow.yml
  name: GitHub Actions Prune Repository Caches
- type: Arazzo
  url: arazzo/github-actions-register-runner-workflow.yml
  name: GitHub Actions Register a Self-hosted Runner
- type: Arazzo
  url: arazzo/github-actions-rerun-failed-run-workflow.yml
  name: GitHub Actions Re-run Failed Jobs and Track
- type: Arazzo
  url: arazzo/github-actions-share-org-secret-workflow.yml
  name: GitHub Actions Share an Organization Secret with Selected Repositories
- type: Arazzo
  url: arazzo/github-actions-upsert-repo-secret-workflow.yml
  name: GitHub Actions Upsert a Repository Secret
- type: Arazzo
  url: arazzo/github-actions-upsert-repo-variable-workflow.yml
  name: GitHub Actions Upsert a Repository Variable
- type: TermsOfService
  url: https://docs.github.com/en/site-policy/github-terms/github-terms-of-service
- type: PrivacyPolicy
  url: https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement
- type: RateLimits
  url: https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
- type: Blog
  url: https://github.blog/category/product/actions/
- type: StatusPage
  url: https://www.githubstatus.com
- type: ChangeLog
  url: https://github.blog/changelog/label/actions/
- type: GettingStarted
  url: https://docs.github.com/en/actions/get-started/quickstart
- type: Authentication
  url: https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
- type: Support
  url: https://support.github.com
- type: Pricing
  url: https://github.com/pricing
- type: GitHubOrganization
  url: https://github.com/github
- type: Portal
  url: https://docs.github.com/en/rest
- type: Documentation
  url: https://docs.github.com/en/actions
- type: Signup
  url: https://github.com/signup
- type: Login
  url: https://github.com/login
- type: DeveloperPortal
  url: https://developer.github.com/
- type: Marketplace
  url: https://github.com/marketplace?type=actions
- type: StackOverflow
  url: https://stackoverflow.com/questions/tagged/github-actions
- type: YouTube
  url: https://www.youtube.com/github
- type: SDKs
  url: https://github.com/octokit/octokit.js
  title: JavaScript SDK
- type: SDKs
  url: https://github.com/octokit/octokit.rb
  title: Ruby SDK
- type: SDKs
  url: https://github.com/octokit/octokit.net
  title: .NET SDK
- type: SDKs
  url: https://github.com/google/go-github
  title: Go SDK
- type: CLI
  url: https://cli.github.com/
- type: GettingStarted
  url: https://docs.github.com/en/rest/quickstart
- type: Security
  url: https://docs.github.com/en/actions/security-for-github-actions
- type: JSONLD
  url: json-ld/github-actions-context.jsonld
- type: JSONSchema
  url: json-schema/github-actions-workflow-schema.json
- type: JSONSchema
  url: json-schema/github-actions-run-schema.json
- type: JSONSchema
  url: json-schema/github-actions-job-schema.json
- type: JSONSchema
  url: json-schema/github-actions-artifact-schema.json
- type: JSONSchema
  url: json-schema/github-actions-secret-schema.json
- type: JSONSchema
  url: json-schema/github-actions-runner-schema.json
- type: JSONSchema
  url: json-schema/github-actions-variable-schema.json
- type: JSONSchema
  url: json-schema/github-actions-cache-schema.json
- type: JSONSchema
  url: json-schema/github-actions-simple-user-schema.json
- type: Capabilities
  url: capabilities/ci-cd-automation.yaml
  title: CI/CD Automation Capability
- type: Capabilities
  url: capabilities/shared/actions.yaml
  title: Actions API Shared Definition
- type: Features
  data:
  - Automated CI/CD workflows triggered by repository events
  - Matrix builds across multiple OS and language versions
  - Reusable workflows and composite actions
  - Encrypted secrets and variables at repo, org, and environment scopes
  - Self-hosted and GitHub-hosted runner management
  - Workflow artifact storage and sharing
  - Deployment protection rules and environment approvals
  - OIDC integration for cloud provider authentication
  - Dependency caching for faster builds
  - Runner groups for organizational access control
- type: UseCases
  data:
  - Continuous integration and testing on every push or pull request
  - Automated deployment to cloud environments
  - Scheduled maintenance and cleanup workflows
  - Building and publishing container images
  - Automated code quality and security scanning
  - Release management and artifact publishing
- type: Integrations
  data:
  - AWS (via OIDC)
  - Azure (via OIDC)
  - Google Cloud (via OIDC)
  - Docker Hub
  - npm
  - PyPI
  - Slack
  - Jira
- type: LlmsText
  url: https://docs.github.com/llms.txt
- type: LLMsTxt
  url: llms/github-actions-llms.txt
- type: Packages
  url: packages/github-actions-packages.yml
- type: WellKnown
  url: well-known/github-actions-well-known.yml
- type: SecurityTxt
  url: well-known/github-actions-security.txt
- type: MCPServer
  url: mcp/github-actions-mcp.yml
- type: Overlay
  url: overlays/github-actions-openapi-overlay.yaml
- type: Conformance
  url: conformance/github-actions-conformance.yml
- type: ErrorCatalog
  url: errors/github-actions-error-codes.yml
- type: Lifecycle
  url: lifecycle/github-actions-lifecycle.yml
- type: OAuthScopes
  url: scopes/github-actions-scopes.yml
- type: DomainSecurity
  url: security/github-actions-domain-security.yml
- type: VulnerabilityDisclosure
  url: security/github-actions-vulnerability-disclosure.yml
- type: TrustCenter
  url: security/github-actions-trust-center.yml
- type: Conventions
  url: conventions/github-actions-conventions.yml
- type: ChangeLog
  url: changelog/github-actions-changelog.yml
- type: CLI
  url: cli/github-actions-cli.yml
- type: DataModel
  url: data-model/github-actions-data-model.yml