GitHub Actions API

GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub One. GitHub Actions is not available for repositories owned by accounts using legacy per-repository plans. For more information, see GitHub's products in the GitHub Help documentation.

Warning: The GitHub Actions API is currently in public beta and subject to change.

The GitHub Actions API enables you to manage GitHub Actions using the REST API. This API is available for authenticated users, OAuth Apps, and GitHub Apps. Access tokens require repo scope for private repos and public_repo scope for public repos. GitHub Apps require the permissions mentioned in each endpoint. For more information, see "GitHub Actions Documentation" in the GitHub Help documentation.

Artifacts

The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts. Artifacts enable you to share data between jobs in a workflow and store data once that workflow has completed.

Secrets

The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. Encrypted secrets allow you to store sensitive information, such as access tokens, in your repository.

Self-hosted runners

The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. Self-hosted runners allow you to host your own runners and customize the environment used to run jobs in your GitHub Actions workflows.

Workflows

The Workflows API allows you to view workflows for a repository. Workflows automate your software development life cycle with a wide range of tools and services.

Workflow jobs

The Workflow Jobs API allows you to view logs and workflow jobs. A workflow job is a defined task made up of steps.

Workflow runs

The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs. A workflow run is an instance of your workflow that runs when the pre-configured event occurs.