GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • GitHub Docs
  • REST API
  • Quickstart
  • About the REST API
  • Comparing GitHub's APIs
  • API Versions
  • Breaking changes
  • OpenAPI description
  • Getting started
  • Rate limits
  • Pagination
  • Libraries
  • Best practices
  • Troubleshooting

This view

  • Original page
  • New address

GeezerVison is showing docs.github.com — REST API endpoints for GitHub Actions - GitHub Docs

The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for GitHub Actions

Use the REST API to interact with GitHub Actions for an organization or repository.

  • REST API endpoints for GitHub Actions artifacts, 1 of 14
    • List artifacts for a repository, 1 of 5
    • Get an artifact, 2 of 5
    • Delete an artifact, 3 of 5
    • Download an artifact, 4 of 5
    • List workflow run artifacts, 5 of 5
  • REST API endpoints for GitHub Actions cache, 2 of 14
    • Get GitHub Actions cache retention limit for an enterprise, 1 of 18
    • Set GitHub Actions cache retention limit for an enterprise, 2 of 18
    • Get GitHub Actions cache storage limit for an enterprise, 3 of 18
    • Set GitHub Actions cache storage limit for an enterprise, 4 of 18
    • Get GitHub Actions cache retention limit for an organization, 5 of 18
    • Set GitHub Actions cache retention limit for an organization, 6 of 18
    • Get GitHub Actions cache storage limit for an organization, 7 of 18
    • Set GitHub Actions cache storage limit for an organization, 8 of 18
    • Get GitHub Actions cache usage for an organization, 9 of 18
    • List repositories with GitHub Actions cache usage for an organization, 10 of 18
    • Get GitHub Actions cache retention limit for a repository, 11 of 18
    • Set GitHub Actions cache retention limit for a repository, 12 of 18
    • Get GitHub Actions cache storage limit for a repository, 13 of 18
    • Set GitHub Actions cache storage limit for a repository, 14 of 18
    • Get GitHub Actions cache usage for a repository, 15 of 18
    • List GitHub Actions caches for a repository, 16 of 18
    • Delete GitHub Actions caches for a repository (using a cache key), 17 of 18
    • Delete a GitHub Actions cache for a repository (using a cache ID), 18 of 18
  • REST API endpoints for Actions concurrency groups, 3 of 14
    • List concurrency groups for a repository, 1 of 3
    • Get a concurrency group for a repository, 2 of 3
    • List concurrency groups for a workflow run, 3 of 3
  • GitHub-hosted runners, 4 of 14
    • List GitHub-hosted runners for an organization, 1 of 16
    • Create a GitHub-hosted runner for an organization, 2 of 16
    • List custom images for an organization, 3 of 16
    • Get a custom image definition for GitHub Actions Hosted Runners, 4 of 16
    • Delete a custom image from the organization, 5 of 16
    • List image versions of a custom image for an organization, 6 of 16
    • Get an image version of a custom image for GitHub Actions Hosted Runners, 7 of 16
    • Delete an image version of custom image from the organization, 8 of 16
    • Get GitHub-owned images for GitHub-hosted runners in an organization, 9 of 16
    • Get partner images for GitHub-hosted runners in an organization, 10 of 16
    • Get limits on GitHub-hosted runners for an organization, 11 of 16
    • Get GitHub-hosted runners machine specs for an organization, 12 of 16
    • Get platforms for GitHub-hosted runners in an organization, 13 of 16
    • Get a GitHub-hosted runner for an organization, 14 of 16
    • Update a GitHub-hosted runner for an organization, 15 of 16
    • Delete a GitHub-hosted runner for an organization, 16 of 16
  • REST API endpoints for GitHub Actions OIDC, 5 of 14
    • List OIDC custom property inclusions for an enterprise, 1 of 10
    • Create an OIDC custom property inclusion for an enterprise, 2 of 10
    • Delete an OIDC custom property inclusion for an enterprise, 3 of 10
    • List OIDC custom property inclusions for an organization, 4 of 10
    • Create an OIDC custom property inclusion for an organization, 5 of 10
    • Delete an OIDC custom property inclusion for an organization, 6 of 10
    • Get the customization template for an OIDC subject claim for an organization, 7 of 10
    • Set the customization template for an OIDC subject claim for an organization, 8 of 10
    • Get the customization template for an OIDC subject claim for a repository, 9 of 10
    • Set the customization template for an OIDC subject claim for a repository, 10 of 10
  • REST API endpoints for GitHub Actions permissions, 6 of 14
    • Get GitHub Actions permissions for an organization, 1 of 36
    • Set GitHub Actions permissions for an organization, 2 of 36
    • Get artifact and log retention settings for an organization, 3 of 36
    • Set artifact and log retention settings for an organization, 4 of 36
    • Get fork PR contributor approval permissions for an organization, 5 of 36
    • Set fork PR contributor approval permissions for an organization, 6 of 36
    • Get private repo fork PR workflow settings for an organization, 7 of 36
    • Set private repo fork PR workflow settings for an organization, 8 of 36
    • List selected repositories enabled for GitHub Actions in an organization, 9 of 36
    • Set selected repositories enabled for GitHub Actions in an organization, 10 of 36
    • Enable a selected repository for GitHub Actions in an organization, 11 of 36
    • Disable a selected repository for GitHub Actions in an organization, 12 of 36
    • Get allowed actions and reusable workflows for an organization, 13 of 36
    • Set allowed actions and reusable workflows for an organization, 14 of 36
    • Get self-hosted runners settings for an organization, 15 of 36
    • Set self-hosted runners settings for an organization, 16 of 36
    • List repositories allowed to use self-hosted runners in an organization, 17 of 36
    • Set repositories allowed to use self-hosted runners in an organization, 18 of 36
    • Add a repository to the list of repositories allowed to use self-hosted runners in an organization, 19 of 36
    • Remove a repository from the list of repositories allowed to use self-hosted runners in an organization, 20 of 36
    • Get default workflow permissions for an organization, 21 of 36
    • Set default workflow permissions for an organization, 22 of 36
    • Get GitHub Actions permissions for a repository, 23 of 36
    • Set GitHub Actions permissions for a repository, 24 of 36
    • Get the level of access for workflows outside of the repository, 25 of 36
    • Set the level of access for workflows outside of the repository, 26 of 36
    • Get artifact and log retention settings for a repository, 27 of 36
    • Set artifact and log retention settings for a repository, 28 of 36
    • Get fork PR contributor approval permissions for a repository, 29 of 36
    • Set fork PR contributor approval permissions for a repository, 30 of 36
    • Get private repo fork PR workflow settings for a repository, 31 of 36
    • Set private repo fork PR workflow settings for a repository, 32 of 36
    • Get allowed actions and reusable workflows for a repository, 33 of 36
    • Set allowed actions and reusable workflows for a repository, 34 of 36
    • Get default workflow permissions for a repository, 35 of 36
    • Set default workflow permissions for a repository, 36 of 36
  • REST API endpoints for GitHub Actions policies, 7 of 14
    • List organization Actions policies, 1 of 10
    • Create an organization Actions policy, 2 of 10
    • Get an organization Actions policy, 3 of 10
    • Update an organization Actions policy, 4 of 10
    • Delete an organization Actions policy, 5 of 10
    • List repository Actions policies, 6 of 10
    • Create a repository Actions policy, 7 of 10
    • Get a repository Actions policy, 8 of 10
    • Update a repository Actions policy, 9 of 10
    • Delete a repository Actions policy, 10 of 10
  • REST API endpoints for GitHub Actions Secrets, 8 of 14
    • List organization secrets, 1 of 20
    • Get an organization public key, 2 of 20
    • Get an organization secret, 3 of 20
    • Create or update an organization secret, 4 of 20
    • Delete an organization secret, 5 of 20
    • List selected repositories for an organization secret, 6 of 20
    • Set selected repositories for an organization secret, 7 of 20
    • Add selected repository to an organization secret, 8 of 20
    • Remove selected repository from an organization secret, 9 of 20
    • List repository organization secrets, 10 of 20
    • List repository secrets, 11 of 20
    • Get a repository public key, 12 of 20
    • Get a repository secret, 13 of 20
    • Create or update a repository secret, 14 of 20
    • Delete a repository secret, 15 of 20
    • List environment secrets, 16 of 20
    • Get an environment public key, 17 of 20
    • Get an environment secret, 18 of 20
    • Create or update an environment secret, 19 of 20
    • Delete an environment secret, 20 of 20
  • REST API endpoints for self-hosted runner groups, 9 of 14
    • List self-hosted runner groups for an organization, 1 of 14
    • Create a self-hosted runner group for an organization, 2 of 14
    • Get a self-hosted runner group for an organization, 3 of 14
    • Update a self-hosted runner group for an organization, 4 of 14
    • Delete a self-hosted runner group from an organization, 5 of 14
    • List GitHub-hosted runners in a group for an organization, 6 of 14
    • List repository access to a self-hosted runner group in an organization, 7 of 14
    • Set repository access for a self-hosted runner group in an organization, 8 of 14
    • Add repository access to a self-hosted runner group in an organization, 9 of 14
    • Remove repository access to a self-hosted runner group in an organization, 10 of 14
    • List self-hosted runners in a group for an organization, 11 of 14
    • Set self-hosted runners in a group for an organization, 12 of 14
    • Add a self-hosted runner to a group for an organization, 13 of 14
    • Remove a self-hosted runner from a group for an organization, 14 of 14
  • REST API endpoints for self-hosted runners, 10 of 14
    • List self-hosted runners for an organization, 1 of 26
    • Get runner version end-of-life schedule for an organization, 2 of 26
    • List runner applications for an organization, 3 of 26
    • Create configuration for a just-in-time runner for an organization, 4 of 26
    • Create a registration token for an organization, 5 of 26
    • Create a remove token for an organization, 6 of 26
    • Get a self-hosted runner for an organization, 7 of 26
    • Delete a self-hosted runner from an organization, 8 of 26
    • List labels for a self-hosted runner for an organization, 9 of 26
    • Add custom labels to a self-hosted runner for an organization, 10 of 26
    • Set custom labels for a self-hosted runner for an organization, 11 of 26
    • Remove all custom labels from a self-hosted runner for an organization, 12 of 26
    • Remove a custom label from a self-hosted runner for an organization, 13 of 26
    • List self-hosted runners for a repository, 14 of 26
    • Get runner version end-of-life schedule for a repository, 15 of 26
    • List runner applications for a repository, 16 of 26
    • Create configuration for a just-in-time runner for a repository, 17 of 26
    • Create a registration token for a repository, 18 of 26
    • Create a remove token for a repository, 19 of 26
    • Get a self-hosted runner for a repository, 20 of 26
    • Delete a self-hosted runner from a repository, 21 of 26
    • List labels for a self-hosted runner for a repository, 22 of 26
    • Add custom labels to a self-hosted runner for a repository, 23 of 26
    • Set custom labels for a self-hosted runner for a repository, 24 of 26
    • Remove all custom labels from a self-hosted runner for a repository, 25 of 26
    • Remove a custom label from a self-hosted runner for a repository, 26 of 26
  • REST API endpoints for GitHub Actions variables, 11 of 14
    • List organization variables, 1 of 20
    • Create an organization variable, 2 of 20
    • Get an organization variable, 3 of 20
    • Update an organization variable, 4 of 20
    • Delete an organization variable, 5 of 20
    • List selected repositories for an organization variable, 6 of 20
    • Set selected repositories for an organization variable, 7 of 20
    • Add selected repository to an organization variable, 8 of 20
    • Remove selected repository from an organization variable, 9 of 20
    • List repository organization variables, 10 of 20
    • List repository variables, 11 of 20
    • Create a repository variable, 12 of 20
    • Get a repository variable, 13 of 20
    • Update a repository variable, 14 of 20
    • Delete a repository variable, 15 of 20
    • List environment variables, 16 of 20
    • Create an environment variable, 17 of 20
    • Get an environment variable, 18 of 20
    • Update an environment variable, 19 of 20
    • Delete an environment variable, 20 of 20
  • REST API endpoints for workflow jobs, 12 of 14
    • Get a job for a workflow run, 1 of 5
    • Download job logs for a workflow run, 2 of 5
    • Download step logs for a workflow run job, 3 of 5
    • List jobs for a workflow run attempt, 4 of 5
    • List jobs for a workflow run, 5 of 5
  • REST API endpoints for workflow runs, 13 of 14
    • Re-run a job from a workflow run, 1 of 19
    • List workflow runs for a repository, 2 of 19
    • Get a workflow run, 3 of 19
    • Delete a workflow run, 4 of 19
    • Get the review history for a workflow run, 5 of 19
    • Approve a workflow run for a fork pull request, 6 of 19
    • Get a workflow run attempt, 7 of 19
    • Download workflow run attempt logs, 8 of 19
    • Cancel a workflow run, 9 of 19
    • Review custom deployment protection rules for a workflow run, 10 of 19
    • Force cancel a workflow run, 11 of 19
    • Download workflow run logs, 12 of 19
    • Delete workflow run logs, 13 of 19
    • Get pending deployments for a workflow run, 14 of 19
    • Review pending deployments for a workflow run, 15 of 19
    • Re-run a workflow, 16 of 19
    • Re-run failed jobs from a workflow run, 17 of 19
    • Get workflow run usage, 18 of 19
    • List workflow runs for a workflow, 19 of 19
  • REST API endpoints for workflows, 14 of 14
    • List repository workflows, 1 of 6
    • Get a workflow, 2 of 6
    • Disable a workflow, 3 of 6
    • Create a workflow dispatch event, 4 of 6
    • Enable a workflow, 5 of 6
    • Get workflow usage, 6 of 6
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.