You can use the REST API to manage and control GitHub Actions for an organization or repository. These endpoints are available for authenticated users, OAuth Apps, and GitHub Apps. Access tokens require repo scope for private repositories and public_repo scope for public repositories. GitHub Apps require the permissions mentioned in each endpoint. For more information, see "GitHub Actions Documentation."
The REST API is now versioned. For more information, see "About API versioning."
Actions
Use the REST API to interact with GitHub Actions for an organization or repository.
- GitHub Actions Artifacts
- List artifacts for a repository
- Get an artifact
- Delete an artifact
- Download an artifact
- List workflow run artifacts
- GitHub Actions Cache
- Get GitHub Actions cache usage for an organization
- List repositories with GitHub Actions cache usage for an organization
- Get GitHub Actions cache usage for a repository
- List GitHub Actions caches for a repository
- Delete GitHub Actions caches for a repository (using a cache key)
- Delete a GitHub Actions cache for a repository (using a cache ID)
- GitHub Actions OIDC
- Get the customization template for an OIDC subject claim for an organization
- Set the customization template for an OIDC subject claim for an organization
- Get the customization template for an OIDC subject claim for a repository
- Set the customization template for an OIDC subject claim for a repository
- GitHub Actions Permissions
- Get GitHub Actions permissions for an organization
- Set GitHub Actions permissions for an organization
- List selected repositories enabled for GitHub Actions in an organization
- Set selected repositories enabled for GitHub Actions in an organization
- Enable a selected repository for GitHub Actions in an organization
- Disable a selected repository for GitHub Actions in an organization
- Get allowed actions and reusable workflows for an organization
- Set allowed actions and reusable workflows for an organization
- Get default workflow permissions for an organization
- Set default workflow permissions for an organization
- Get GitHub Actions permissions for a repository
- Set GitHub Actions permissions for a repository
- Get the level of access for workflows outside of the repository
- Set the level of access for workflows outside of the repository
- Get allowed actions and reusable workflows for a repository
- Set allowed actions and reusable workflows for a repository
- Get default workflow permissions for a repository
- Set default workflow permissions for a repository
- GitHub Actions Required Workflows
- List required workflows
- Create a required workflow
- Get a required workflow
- Update a required workflow
- Delete a required workflow
- List selected repositories for a required workflow
- Sets repositories for a required workflow
- Add a repository to a required workflow
- Remove a selected repository from required workflow
- List repository required workflows
- Get a required workflow entity for a repository
- Get required workflow usage
- GitHub Actions Secrets
- List organization secrets
- Get an organization public key
- Get an organization secret
- Create or update an organization secret
- Delete an organization secret
- List selected repositories for an organization secret
- Set selected repositories for an organization secret
- Add selected repository to an organization secret
- Remove selected repository from an organization secret
- List repository secrets
- Get a repository public key
- Get a repository secret
- Create or update a repository secret
- Delete a repository secret
- List environment secrets
- Get an environment public key
- Get an environment secret
- Create or update an environment secret
- Delete an environment secret
- Self-hosted runners
- List self-hosted runners for an organization
- List runner applications for an organization
- Create a registration token for an organization
- Create a remove token for an organization
- Get a self-hosted runner for an organization
- Delete a self-hosted runner from an organization
- List labels for a self-hosted runner for an organization
- Add custom labels to a self-hosted runner for an organization
- Set custom labels for a self-hosted runner for an organization
- Remove all custom labels from a self-hosted runner for an organization
- Remove a custom label from a self-hosted runner for an organization
- List self-hosted runners for a repository
- List runner applications for a repository
- Create a registration token for a repository
- Create a remove token for a repository
- Get a self-hosted runner for a repository
- Delete a self-hosted runner from a repository
- List labels for a self-hosted runner for a repository
- Add custom labels to a self-hosted runner for a repository
- Set custom labels for a self-hosted runner for a repository
- Remove all custom labels from a self-hosted runner for a repository
- Remove a custom label from a self-hosted runner for a repository
- GitHub Actions Variables
- List organization variables
- Create an organization variable
- Get an organization variable
- Update an organization variable
- Delete an organization variable
- List selected repositories for an organization variable
- Set selected repositories for an organization variable
- Add selected repository to an organization variable
- Remove selected repository from an organization variable
- List repository variables
- Create a repository variable
- Get a repository variable
- Update a repository variable
- Delete a repository variable
- List environment variables
- Create an environment variable
- Get an environment variable
- Update an environment variable
- Delete an environment variable
- Workflow jobs
- Get a job for a workflow run
- Download job logs for a workflow run
- List jobs for a workflow run attempt
- List jobs for a workflow run
- Workflow runs
- Re-run a job from a workflow run
- List workflow runs for a required workflow
- List workflow runs for a repository
- Get a workflow run
- Delete a workflow run
- Get the review history for a workflow run
- Approve a workflow run for a fork pull request
- Get a workflow run attempt
- Download workflow run attempt logs
- Cancel a workflow run
- Download workflow run logs
- Delete workflow run logs
- Get pending deployments for a workflow run
- Review pending deployments for a workflow run
- Re-run a workflow
- Re-run failed jobs from a workflow run
- Get workflow run usage
- List workflow runs for a workflow
- Workflows