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."
This version of GitHub Enterprise was discontinued on 2023-07-06. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.
After a site administrator upgrades your Enterprise Server instance to Enterprise Server 3.9 or later, the REST API will be versioned. To learn how to find your instance's version, see "About versions of GitHub Docs". 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 enterprise
- Get GitHub Actions cache usage policy for an enterprise
- Set GitHub Actions cache usage policy for an enterprise
- 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
- Get GitHub Actions cache usage policy for a repository
- Set GitHub Actions cache usage policy for a repository
- GitHub Actions Permissions
- Get GitHub Actions permissions for an enterprise
- Set GitHub Actions permissions for an enterprise
- List selected organizations enabled for GitHub Actions in an enterprise
- Set selected organizations enabled for GitHub Actions in an enterprise
- Enable a selected organization for GitHub Actions in an enterprise
- Disable a selected organization for GitHub Actions in an enterprise
- Get allowed actions for an enterprise
- Set allowed actions for an enterprise
- 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 for an organization
- Set allowed actions 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 for a repository
- Set allowed actions for a repository
- 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 runner groups
- List self-hosted runner groups for an enterprise
- Create a self-hosted runner group for an enterprise
- Get a self-hosted runner group for an enterprise
- Update a self-hosted runner group for an enterprise
- Delete a self-hosted runner group from an enterprise
- List organization access to a self-hosted runner group in an enterprise
- Set organization access for a self-hosted runner group in an enterprise
- Add organization access to a self-hosted runner group in an enterprise
- Remove organization access to a self-hosted runner group in an enterprise
- List self-hosted runners in a group for an enterprise
- Set self-hosted runners in a group for an enterprise
- Add a self-hosted runner to a group for an enterprise
- Remove a self-hosted runner from a group for an enterprise
- List self-hosted runner groups for an organization
- Create a self-hosted runner group for an organization
- Get a self-hosted runner group for an organization
- Update a self-hosted runner group for an organization
- Delete a self-hosted runner group from an organization
- List repository access to a self-hosted runner group in an organization
- Set repository access for a self-hosted runner group in an organization
- Add repository access to a self-hosted runner group in an organization
- Remove repository access to a self-hosted runner group in an organization
- List self-hosted runners in a group for an organization
- Set self-hosted runners in a group for an organization
- Add a self-hosted runner to a group for an organization
- Remove a self-hosted runner from a group for an organization
- Self-hosted runners
- List self-hosted runners for an enterprise
- List runner applications for an enterprise
- Create a registration token for an enterprise
- Create a remove token for an enterprise
- Get a self-hosted runner for an enterprise
- Delete a self-hosted runner from an enterprise
- List labels for a self-hosted runner for an enterprise
- Add custom labels to a self-hosted runner for an enterprise
- Set custom labels for a self-hosted runner for an enterprise
- Remove all custom labels from a self-hosted runner for an enterprise
- Remove a custom label from a self-hosted runner for an enterprise
- 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
- 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 repository
- Get a workflow run
- Delete a workflow run
- Get the review history for a workflow run
- 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
- List workflow runs for a workflow
- Workflows