# GitHub Actions Actions API

**Canonical:** https://apis.io/apis/github-actions/github-actions-actions-api/  
**Provider:** GitHub Actions — https://apis.io/providers/github-actions/  
**Base URL:** https://api.github.com  
**Documentation:** https://docs.github.com/en/actions

GitHub Actions Actions API is one of 3 APIs that [GitHub Actions](https://apis.io/providers/github-actions/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, a changelog, and 6 JSON Schemas.

Endpoints to manage GitHub Actions using the REST API.

## Operations (60 of 190)

| Method | Path | Summary |
|---|---|---|
| GET | `/enterprises/{enterprise}/actions/cache/retention-limit` | Get GitHub Actions cache retention limit for an enterprise |
| PUT | `/enterprises/{enterprise}/actions/cache/retention-limit` | Set GitHub Actions cache retention limit for an enterprise |
| GET | `/enterprises/{enterprise}/actions/cache/storage-limit` | Get GitHub Actions cache storage limit for an enterprise |
| PUT | `/enterprises/{enterprise}/actions/cache/storage-limit` | Set GitHub Actions cache storage limit for an enterprise |
| GET | `/organizations/{org}/actions/cache/retention-limit` | Get GitHub Actions cache retention limit for an organization |
| PUT | `/organizations/{org}/actions/cache/retention-limit` | Set GitHub Actions cache retention limit for an organization |
| GET | `/organizations/{org}/actions/cache/storage-limit` | Get GitHub Actions cache storage limit for an organization |
| PUT | `/organizations/{org}/actions/cache/storage-limit` | Set GitHub Actions cache storage limit for an organization |
| GET | `/orgs/{org}/actions/cache/usage` | Get GitHub Actions cache usage for an organization |
| GET | `/orgs/{org}/actions/cache/usage-by-repository` | List repositories with GitHub Actions cache usage for an organization |
| GET | `/orgs/{org}/actions/hosted-runners` | List GitHub-hosted runners for an organization |
| POST | `/orgs/{org}/actions/hosted-runners` | Create a GitHub-hosted runner for an organization |
| GET | `/orgs/{org}/actions/hosted-runners/images/custom` | List custom images for an organization |
| GET | `/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}` | Get a custom image definition for GitHub Actions Hosted Runners |
| DELETE | `/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}` | Delete a custom image from the organization |
| GET | `/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions` | List image versions of a custom image for an organization |
| GET | `/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}` | Get an image version of a custom image for GitHub Actions Hosted Runners |
| DELETE | `/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}` | Delete an image version of custom image from the organization |
| GET | `/orgs/{org}/actions/hosted-runners/images/github-owned` | Get GitHub-owned images for GitHub-hosted runners in an organization |
| GET | `/orgs/{org}/actions/hosted-runners/images/partner` | Get partner images for GitHub-hosted runners in an organization |
| GET | `/orgs/{org}/actions/hosted-runners/limits` | Get limits on GitHub-hosted runners for an organization |
| GET | `/orgs/{org}/actions/hosted-runners/machine-sizes` | Get GitHub-hosted runners machine specs for an organization |
| GET | `/orgs/{org}/actions/hosted-runners/platforms` | Get platforms for GitHub-hosted runners in an organization |
| GET | `/orgs/{org}/actions/hosted-runners/{hosted_runner_id}` | Get a GitHub-hosted runner for an organization |
| PATCH | `/orgs/{org}/actions/hosted-runners/{hosted_runner_id}` | Update a GitHub-hosted runner for an organization |
| DELETE | `/orgs/{org}/actions/hosted-runners/{hosted_runner_id}` | Delete a GitHub-hosted runner for an organization |
| GET | `/orgs/{org}/actions/permissions` | Get GitHub Actions permissions for an organization |
| PUT | `/orgs/{org}/actions/permissions` | Set GitHub Actions permissions for an organization |
| GET | `/orgs/{org}/actions/permissions/artifact-and-log-retention` | Get artifact and log retention settings for an organization |
| PUT | `/orgs/{org}/actions/permissions/artifact-and-log-retention` | Set artifact and log retention settings for an organization |
| GET | `/orgs/{org}/actions/permissions/fork-pr-contributor-approval` | Get fork PR contributor approval permissions for an organization |
| PUT | `/orgs/{org}/actions/permissions/fork-pr-contributor-approval` | Set fork PR contributor approval permissions for an organization |
| GET | `/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos` | Get private repo fork PR workflow settings for an organization |
| PUT | `/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos` | Set private repo fork PR workflow settings for an organization |
| GET | `/orgs/{org}/actions/permissions/repositories` | List selected repositories enabled for GitHub Actions in an organization |
| PUT | `/orgs/{org}/actions/permissions/repositories` | Set selected repositories enabled for GitHub Actions in an organization |
| PUT | `/orgs/{org}/actions/permissions/repositories/{repository_id}` | Enable a selected repository for GitHub Actions in an organization |
| DELETE | `/orgs/{org}/actions/permissions/repositories/{repository_id}` | Disable a selected repository for GitHub Actions in an organization |
| GET | `/orgs/{org}/actions/permissions/selected-actions` | Get allowed actions and reusable workflows for an organization |
| PUT | `/orgs/{org}/actions/permissions/selected-actions` | Set allowed actions and reusable workflows for an organization |
| GET | `/orgs/{org}/actions/permissions/self-hosted-runners` | Get self-hosted runners settings for an organization |
| PUT | `/orgs/{org}/actions/permissions/self-hosted-runners` | Set self-hosted runners settings for an organization |
| GET | `/orgs/{org}/actions/permissions/self-hosted-runners/repositories` | List repositories allowed to use self-hosted runners in an organization |
| PUT | `/orgs/{org}/actions/permissions/self-hosted-runners/repositories` | Set repositories allowed to use self-hosted runners in an organization |
| PUT | `/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}` | Add a repository to the list of repositories allowed to use self-hosted runners… |
| DELETE | `/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}` | Remove a repository from the list of repositories allowed to use self-hosted… |
| GET | `/orgs/{org}/actions/permissions/workflow` | Get default workflow permissions for an organization |
| PUT | `/orgs/{org}/actions/permissions/workflow` | Set default workflow permissions for an organization |
| GET | `/orgs/{org}/actions/policies` | List organization Actions policies |
| POST | `/orgs/{org}/actions/policies` | Create an organization Actions policy |
| GET | `/orgs/{org}/actions/policies/{policy_id}` | Get an organization Actions policy |
| PUT | `/orgs/{org}/actions/policies/{policy_id}` | Update an organization Actions policy |
| DELETE | `/orgs/{org}/actions/policies/{policy_id}` | Delete an organization Actions policy |
| GET | `/orgs/{org}/actions/runner-groups` | List self-hosted runner groups for an organization |
| POST | `/orgs/{org}/actions/runner-groups` | Create a self-hosted runner group for an organization |
| GET | `/orgs/{org}/actions/runner-groups/{runner_group_id}` | Get a self-hosted runner group for an organization |
| PATCH | `/orgs/{org}/actions/runner-groups/{runner_group_id}` | Update a self-hosted runner group for an organization |
| DELETE | `/orgs/{org}/actions/runner-groups/{runner_group_id}` | Delete a self-hosted runner group from an organization |
| GET | `/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners` | List GitHub-hosted runners in a group for an organization |
| GET | `/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories` | List repository access to a self-hosted runner group in an organization |

…and 130 more operations. They are listed in full on the page.

## Machine-readable artifacts (19)

- **OpenAPI** — https://artifacts.apis.io/github-actions/openapi/github-actions-actions-api-openapi.yml
- **Documentation** — https://docs.github.com/en/rest/actions
- **Authentication** — https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api
- **GettingStarted** — https://docs.github.com/en/actions/get-started/quickstart
- **APIReference** — https://docs.github.com/en/rest/actions
- **ChangeLog** — https://github.blog/changelog/label/actions/
- **SDKs** — https://github.com/octokit/octokit.js
- **SDKs** — https://github.com/octokit/octokit.rb
- **SDKs** — https://github.com/octokit/octokit.net
- **SDKs** — https://github.com/google/go-github
- **CLI** — https://cli.github.com/manual/gh_workflow_run
- **RateLimits** — https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
- **JSONLD** — https://artifacts.apis.io/github-actions/json-ld/github-actions-context.jsonld
- **JSONSchema** — https://artifacts.apis.io/github-actions/json-schema/github-actions-repository-schema.json
- **JSONSchema** — https://artifacts.apis.io/github-actions/json-schema/github-actions-minimal-repository-schema.json
- **JSONSchema** — https://artifacts.apis.io/github-actions/json-schema/github-actions-workflow-run-schema.json
- **JSONSchema** — https://artifacts.apis.io/github-actions/json-schema/github-actions-job-schema.json
- **JSONSchema** — https://artifacts.apis.io/github-actions/json-schema/github-actions-concurrency-group-run-list-schema.json
- **JSONSchema** — https://artifacts.apis.io/github-actions/json-schema/github-actions-deployment-schema.json

## Other GitHub Actions APIs (2)

- [GitHub Actions OIDC API](https://apis.io/apis/github-actions/github-actions-oidc-api/)
- [GitHub Actions Merge Queue API](https://apis.io/apis/github-actions/github-actions-merge-queue-api/)

## Tags

Actions

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/github-actions/github-actions-actions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/github-actions/.
