GitHub Actions Actions API
Endpoints to manage GitHub Actions using the REST API.
Operations 190
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-by-repository
List repositories with GitHub Actions cache usage 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/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/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
#
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
Set repository access for a self-hosted runner group in an organization
#
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
Add repository access to a self-hosted runner group in an organization
#
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
Remove repository access to a self-hosted runner group in an organization
#
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
List self-hosted runners in a group for an organization
#
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
Set self-hosted runners in a group for an organization
#
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
Add a self-hosted runner to a group for an organization
#
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
Remove a self-hosted runner from a group for an organization
#
GET
/orgs/{org}/actions/runners/deprecations/{version}
Get runner version end-of-life schedule for an organization
#
POST
/orgs/{org}/actions/runners/generate-jitconfig
Create configuration for a just-in-time runner for an organization
#
POST
/orgs/{org}/actions/runners/registration-token
Create a registration token for an organization
#
GET
/orgs/{org}/actions/runners/{runner_id}/labels
List labels for a self-hosted runner for an organization
#
POST
/orgs/{org}/actions/runners/{runner_id}/labels
Add custom labels to a self-hosted runner for an organization
#
PUT
/orgs/{org}/actions/runners/{runner_id}/labels
Set custom labels for a self-hosted runner for an organization
#
DELETE
/orgs/{org}/actions/runners/{runner_id}/labels
Remove all custom labels from a self-hosted runner for an organization
#
DELETE
/orgs/{org}/actions/runners/{runner_id}/labels/{name}
Remove a custom label from a self-hosted runner for an organization
#
GET
/orgs/{org}/actions/secrets/{secret_name}/repositories
List selected repositories for an organization secret
#
PUT
/orgs/{org}/actions/secrets/{secret_name}/repositories
Set selected repositories for an organization secret
#
PUT
/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}
Add selected repository to an organization secret
#
DELETE
/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}
Remove selected repository from an organization secret
#
GET
/orgs/{org}/actions/variables/{name}/repositories
List selected repositories for an organization variable
#
PUT
/orgs/{org}/actions/variables/{name}/repositories
Set selected repositories for an organization variable
#
PUT
/orgs/{org}/actions/variables/{name}/repositories/{repository_id}
Add selected repository to an organization variable
#
DELETE
/orgs/{org}/actions/variables/{name}/repositories/{repository_id}
Remove selected repository from an organization variable
#
GET
/repos/{owner}/{repo}/actions/cache/retention-limit
Get GitHub Actions cache retention limit for a repository
#
PUT
/repos/{owner}/{repo}/actions/cache/retention-limit
Set GitHub Actions cache retention limit for a repository
#
GET
/repos/{owner}/{repo}/actions/cache/storage-limit
Get GitHub Actions cache storage limit for a repository
#
PUT
/repos/{owner}/{repo}/actions/cache/storage-limit
Set GitHub Actions cache storage limit for a repository
#
DELETE
/repos/{owner}/{repo}/actions/caches
Delete GitHub Actions caches for a repository (using a cache key)
#
DELETE
/repos/{owner}/{repo}/actions/caches/{cache_id}
Delete a GitHub Actions cache for a repository (using a cache ID)
#
GET
/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}
Get a concurrency group for a repository
#
GET
/repos/{owner}/{repo}/actions/jobs/{job_id}/steps/{step_number}/logs
Download step logs for a workflow run job
#
GET
/repos/{owner}/{repo}/actions/oidc/customization/sub
Get the customization template for an OIDC subject claim for a repository
#
PUT
/repos/{owner}/{repo}/actions/oidc/customization/sub
Set the customization template for an OIDC subject claim for a repository
#
GET
/repos/{owner}/{repo}/actions/permissions/access
Get the level of access for workflows outside of the repository
#
PUT
/repos/{owner}/{repo}/actions/permissions/access
Set the level of access for workflows outside of the repository
#
GET
/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention
Get artifact and log retention settings for a repository
#
PUT
/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention
Set artifact and log retention settings for a repository
#
GET
/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval
Get fork PR contributor approval permissions for a repository
#
PUT
/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval
Set fork PR contributor approval permissions for a repository
#
GET
/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos
Get private repo fork PR workflow settings for a repository
#
PUT
/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos
Set private repo fork PR workflow settings for a repository
#
GET
/repos/{owner}/{repo}/actions/permissions/selected-actions
Get allowed actions and reusable workflows for a repository
#
PUT
/repos/{owner}/{repo}/actions/permissions/selected-actions
Set allowed actions and reusable workflows for a repository
#
GET
/repos/{owner}/{repo}/actions/permissions/workflow
Get default workflow permissions for a repository
#
PUT
/repos/{owner}/{repo}/actions/permissions/workflow
Set default workflow permissions for a repository
#
GET
/repos/{owner}/{repo}/actions/runners/deprecations/{version}
Get runner version end-of-life schedule for a repository
#
POST
/repos/{owner}/{repo}/actions/runners/generate-jitconfig
Create configuration for a just-in-time runner for a repository
#
POST
/repos/{owner}/{repo}/actions/runners/registration-token
Create a registration token for a repository
#
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}
Delete a self-hosted runner from a repository
#
GET
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
List labels for a self-hosted runner for a repository
#
POST
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
Add custom labels to a self-hosted runner for a repository
#
PUT
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
Set custom labels for a self-hosted runner for a repository
#
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
Remove all custom labels from a self-hosted runner for a repository
#
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}
Remove a custom label from a self-hosted runner for a repository
#
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/approvals
Get the review history for a workflow run
#
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/approve
Approve a workflow run for a fork pull request
#
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}
Get a workflow run attempt
#
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
List jobs for a workflow run attempt
#
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
Download workflow run attempt logs
#
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups
List concurrency groups for a workflow run
#
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule
Review custom deployment protection rules for a workflow run
#
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
Get pending deployments for a workflow run
#
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
Review pending deployments for a workflow run
#
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs
Re-run failed jobs from a workflow run
#
POST
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
Create a workflow dispatch event
#
Documentation
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
RateLimits
https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api
Specifications
Schemas & Data
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 Resources
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
JSONLD
https://artifacts.apis.io/github-actions/json-ld/github-actions-context.jsonld