GitHub

GitHub Actions API

Endpoints to manage GitHub Actions using the REST API.

GitHub OpenAPI
Business capability
Continuous Integration Management BC-4210.10

Operations 137

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /enterprises/{enterprise}/actions/cache/usage Check Actions cache usage for an enterprise · GitHub Get GitHub Actions Cache Usage for an Enterprise #
Ask an LLM
“How much GitHub Actions cache storage is my whole enterprise using right now?”
“Is enterprise-wide Actions cache usage data real time, or delayed by a few minutes?”
Tell an agent
Show total Actions cache usage across enterprise {enterprise}.
Tell me how many active caches enterprise {enterprise} has and their total size.
GET /enterprises/{enterprise}/actions/cache/usage-policy Get the enterprise Actions cache size policy · GitHub Get GitHub Actions Cache Usage Policy for an Enterprise #
Ask an LLM
“What cache size limit do repos in my enterprise get for GitHub Actions by default?”
“Which maximum repo cache size has my enterprise set as its Actions policy?”
Tell an agent
Get the Actions cache usage policy for enterprise {enterprise}.
Show the default and maximum repo cache size limits configured for enterprise {enterprise}.
PATCH /enterprises/{enterprise}/actions/cache/usage-policy Set the enterprise Actions cache size policy · GitHub Set GitHub Actions Cache Usage Policy for an Enterprise #
Ask an LLM
“Can I raise the default Actions cache size limit for every repo in my enterprise?”
“How do I cap how large a repository's Actions cache can be enterprise-wide?”
Tell an agent
Set the default repo Actions cache limit for enterprise {enterprise} to {repo_cache_size_limit_in_gb} GB.
Cap the maximum repo cache size in enterprise {enterprise} at {max_repo_cache_size_limit_in_gb} GB.
GET /enterprises/{enterprise}/actions/permissions/workflow Get default GITHUB_TOKEN permissions for an enterprise · GitHub Get Default Workflow Permissions for an Enterprise #
Ask an LLM
“What permissions does GITHUB_TOKEN get by default in workflows across my enterprise?”
“Are Actions workflows in my enterprise allowed to approve pull requests?”
Tell an agent
Show the default workflow token permissions for enterprise {enterprise}.
Check whether Actions can approve pull request reviews in enterprise {enterprise}.
PUT /enterprises/{enterprise}/actions/permissions/workflow Set default GITHUB_TOKEN permissions for an enterprise · GitHub Set Default Workflow Permissions for an Enterprise #
Ask an LLM
“Can I make GITHUB_TOKEN read-only by default for every workflow in my enterprise?”
“How do I stop Actions from approving pull requests anywhere in my enterprise?”
Tell an agent
Set the default workflow token permissions for enterprise {enterprise} to {default_workflow_permissions}.
Set whether Actions can approve pull request reviews in enterprise {enterprise} to {can_approve_pull_request_reviews}.
GET /orgs/{org}/actions/cache/usage Check Actions cache usage for an organization · GitHub Get GitHub Actions Cache Usage for an Organization #
Ask an LLM
“How much Actions cache storage is my organization using in total?”
“What is the combined size of all active GitHub Actions caches in my org?”
Tell an agent
Show total Actions cache usage for organization {org}.
Tell me the org-wide Actions cache count and size for {org}.
GET /orgs/{org}/actions/cache/usage-by-repository List repos by Actions cache usage in an org · GitHub List Repositories with GitHub Actions Cache Usage for an Organization #
Ask an LLM
“Which repositories in my organization are using the most Actions cache?”
“Can I see a per-repository breakdown of Actions cache usage across my org?”
Tell an agent
List each repository's Actions cache usage in organization {org}.
Show page {page} of the per-repo Actions cache breakdown for {org}.
GET /orgs/{org}/actions/permissions Get the Actions permissions policy for an org · GitHub Get GitHub Actions Permissions for an Organization #
Ask an LLM
“Which repositories in my organization are allowed to run GitHub Actions?”
“What actions policy does my org apply to repos: all actions, local only, or selected?”
Tell an agent
Get the Actions permissions policy for organization {org}.
Show which repos and which actions are allowed to run in {org}.
PUT /orgs/{org}/actions/permissions Set the Actions permissions policy for an org · GitHub Set GitHub Actions Permissions for an Organization #
Ask an LLM
“Can I turn GitHub Actions on for only selected repositories in my organization?”
“How do I restrict my org so only certain actions are allowed to run?”
Tell an agent
Set Actions in organization {org} to run in {enabled_repositories} repositories.
Enable Actions for {enabled_repositories} repos in {org} and allow {allowed_actions} actions.
GET /orgs/{org}/actions/permissions/repositories List repos enabled for Actions in an org · GitHub List Selected Repositories Enabled for GitHub Actions in an Organization #
Ask an LLM
“Which specific repositories have been picked to run Actions in my org?”
“When my org enables Actions for selected repos only, how do I see that list?”
Tell an agent
List the repositories selected to run Actions in organization {org}.
Show page {page} of Actions-enabled selected repos in {org}.
PUT /orgs/{org}/actions/permissions/repositories Replace the repos enabled for Actions in an org · GitHub Set Selected Repositories Enabled for GitHub Actions in an Organization #
Ask an LLM
“Can I replace the whole list of repositories allowed to run Actions in my org at once?”
“What happens to repos left out when I reset the org's Actions-enabled repository list?”
Tell an agent
Replace the Actions-enabled repositories in organization {org} with {selected_repository_ids}.
Make only repository IDs {selected_repository_ids} able to run Actions in {org}.
PUT /orgs/{org}/actions/permissions/repositories/{repository_id} Enable Actions for one repo in an org · GitHub Enable a Selected Repository for GitHub Actions in an Organization #
Ask an LLM
“How do I let one more repository in my org start running GitHub Actions?”
“Can I add a single repo to my org's selected Actions repositories without touching the rest?”
Tell an agent
Enable Actions for repository {repository_id} in organization {org}.
Add repo {repository_id} to the Actions-enabled list in {org}.
DELETE /orgs/{org}/actions/permissions/repositories/{repository_id} Disable Actions for one repo in an org · GitHub Disable a Selected Repository for GitHub Actions in an Organization #
Ask an LLM
“How do I stop one repository in my org from running GitHub Actions?”
“Can I pull a single repo out of my org's Actions-enabled list?”
Tell an agent destructive · confirm first
Disable Actions for repository {repository_id} in organization {org}.
Remove repo {repository_id} from the Actions-enabled repositories in {org}.
GET /orgs/{org}/actions/permissions/selected-actions Get the allowed actions list for an org · GitHub Get Allowed Actions for an Organization #
Ask an LLM
“Which actions and reusable workflows are allowed to run in my organization?”
“Does my org allow GitHub-owned actions, and what name patterns are permitted?”
Tell an agent
Show the allowed actions settings for organization {org}.
List the action patterns permitted in {org}.
PUT /orgs/{org}/actions/permissions/selected-actions Set the allowed actions list for an org · GitHub Set Allowed Actions for an Organization #
Ask an LLM
“Can I allow only GitHub-owned actions plus a few named patterns in my org?”
“How do I allowlist specific third-party actions for my whole organization?”
Tell an agent
Allow actions matching {patterns_allowed} in organization {org}.
Set GitHub-owned actions allowed to {github_owned_allowed} and patterns to {patterns_allowed} for {org}.
GET /orgs/{org}/actions/permissions/workflow Get default GITHUB_TOKEN permissions for an org · GitHub Get Default Workflow Permissions for an Organization #
Ask an LLM
“What access does GITHUB_TOKEN have by default in my organization's workflows?”
“Can workflows in my org approve pull requests right now?”
Tell an agent
Show default workflow token permissions for organization {org}.
Check whether Actions may approve pull request reviews in {org}.
PUT /orgs/{org}/actions/permissions/workflow Set default GITHUB_TOKEN permissions for an org · GitHub Set Default Workflow Permissions for an Organization #
Ask an LLM
“How can I make workflow tokens read-only by default across my organization?”
“Can I let Actions approve pull requests in my org?”
Tell an agent
Set default workflow token permissions in organization {org} to {default_workflow_permissions}.
Set pull request approval by Actions in {org} to {can_approve_pull_request_reviews}.
GET /orgs/{org}/actions/runner-groups List self-hosted runner groups in an org · GitHub List Self-hosted Runner Groups for an Organization #
Ask an LLM
“Which self-hosted runner groups exist in my organization, including enterprise ones?”
“Can I see only the runner groups a particular repository is allowed to use?”
Tell an agent
List self-hosted runner groups in organization {org}.
Show runner groups in {org} visible to repository {visible_to_repository}.
POST /orgs/{org}/actions/runner-groups Create a self-hosted runner group in an org · GitHub Create a Self-hosted Runner Group for an Organization #
Ask an LLM
“How do I create a new group to organize self-hosted runners in my organization?”
“Can a new runner group be limited to selected repositories or specific workflows?”
Tell an agent
Create a runner group named {name} in organization {org}.
Create runner group {name} in {org} with {visibility} visibility for repositories {selected_repository_ids}.
GET /orgs/{org}/actions/runner-groups/{runner_group_id} Get a self-hosted runner group in an org · GitHub Get a Self-hosted Runner Group for an Organization #
Ask an LLM
“What are the settings of a specific runner group in my org?”
“Is one of my org's runner groups restricted to certain workflows?”
Tell an agent
Get runner group {runner_group_id} in organization {org}.
Show the visibility and workflow restrictions of runner group {runner_group_id} in {org}.
PATCH /orgs/{org}/actions/runner-groups/{runner_group_id} Update a self-hosted runner group in an org · GitHub Update a Self-hosted Runner Group for an Organization #
Ask an LLM
“Can I rename a runner group or change who can see it in my org?”
“How do I let an existing runner group be used by public repositories?”
Tell an agent
Rename runner group {runner_group_id} in organization {org} to {name}.
Set runner group {runner_group_id} in {org} to name {name} with {visibility} visibility.
DELETE /orgs/{org}/actions/runner-groups/{runner_group_id} Delete a self-hosted runner group from an org · GitHub Delete a Self-hosted Runner Group from an Organization #
Ask an LLM
“How do I delete a runner group my organization no longer needs?”
“Can I remove an entire self-hosted runner group from my org?”
Tell an agent destructive · confirm first
Delete runner group {runner_group_id} from organization {org}.
Remove the self-hosted runner group {runner_group_id} in {org}.
GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories List repos that can use an org runner group · GitHub List Repository Access to a Self-hosted Runner Group in an Organization #
Ask an LLM
“Which repositories are allowed to use a given runner group in my org?”
“What repos currently have access to one of my organization's runner groups?”
Tell an agent
List repositories with access to runner group {runner_group_id} in organization {org}.
Show page {page} of repos that can use runner group {runner_group_id} in {org}.
PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories Replace the repos that can use an org runner group · GitHub Set Repository Access for a Self-hosted Runner Group in an Organization #
Ask an LLM
“Can I overwrite the full list of repos allowed to use a runner group in one call?”
“What does resetting a runner group's repository access to a new list look like?”
Tell an agent
Replace the repos with access to runner group {runner_group_id} in {org} with {selected_repository_ids}.
Give only repositories {selected_repository_ids} access to runner group {runner_group_id} in {org}.
PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id} Grant one repo access to an org runner group · GitHub Add Repository Access to a Self-hosted Runner Group in an Organization #
Ask an LLM
“How do I let one more repository use a runner group with selected visibility?”
“Can I add a single repo to a runner group's access list?”
Tell an agent
Grant repository {repository_id} access to runner group {runner_group_id} in organization {org}.
Add repo {repository_id} to runner group {runner_group_id} in {org}.
DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id} Revoke one repo's access to an org runner group · GitHub Remove Repository Access to a Self-hosted Runner Group in an Organization #
Ask an LLM
“How do I stop a repository from using one of my org's runner groups?”
“Can I take a single repo out of a runner group's access list?”
Tell an agent destructive · confirm first
Revoke repository {repository_id} access to runner group {runner_group_id} in organization {org}.
Remove repo {repository_id} from runner group {runner_group_id} access in {org}.
GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners List the runners in an org runner group · GitHub List Self-hosted Runners in a Group for an Organization #
Ask an LLM
“Which self-hosted runners belong to a particular group in my org?”
“What machines are assigned to one of my organization's runner groups?”
Tell an agent
List the runners in runner group {runner_group_id} in organization {org}.
Show page {page} of runners assigned to group {runner_group_id} in {org}.
PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners Replace the runners in an org runner group · GitHub Set Self-hosted Runners in a Group for an Organization #
Ask an LLM
“Can I replace every runner in a group with a new set in one step?”
“How do I redefine exactly which runners make up an org runner group?”
Tell an agent
Replace the runners in group {runner_group_id} in {org} with {runners}.
Make runner group {runner_group_id} in organization {org} contain only runners {runners}.
PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id} Add a runner to an org runner group · GitHub Add a Self-hosted Runner to a Group for an Organization #
Ask an LLM
“How do I move a self-hosted runner into a specific runner group in my org?”
“Can I assign one runner to a runner group without changing the others?”
Tell an agent
Add runner {runner_id} to runner group {runner_group_id} in organization {org}.
Put self-hosted runner {runner_id} into group {runner_group_id} in {org}.
DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id} Remove a runner from an org runner group · GitHub Remove a Self-hosted Runner from a Group for an Organization #
Ask an LLM
“What happens to a runner when I take it out of an org runner group?”
“Can I send a runner back to the default group in my organization?”
Tell an agent destructive · confirm first
Remove runner {runner_id} from runner group {runner_group_id} in organization {org}.
Move runner {runner_id} out of group {runner_group_id} in {org} back to the default group.
GET /orgs/{org}/actions/runners List self-hosted runners in an org · GitHub List Self-hosted Runners for an Organization #
Ask an LLM
“Which self-hosted runners are registered to my organization?”
“Can I see every org-level runner along with its status?”
Tell an agent
List all self-hosted runners in organization {org}.
Show page {page} of self-hosted runners for {org}.
GET /orgs/{org}/actions/runners/downloads List runner app downloads for an org · GitHub List Runner Applications for an Organization #
Ask an LLM
“Where do I download the runner application binaries to set up an org runner?”
“Which operating systems and architectures is the runner application offered for?”
Tell an agent
List runner application downloads for organization {org}.
Get the runner binaries I can install for {org}.
POST /orgs/{org}/actions/runners/registration-token Create a token to register an org runner · GitHub Create a Registration Token for an Organization #
Ask an LLM
“How do I get a token to register a new self-hosted runner with my organization?”
“How long does an org runner registration token stay valid?”
Tell an agent
Create a runner registration token for organization {org}.
Generate a token so I can configure a new self-hosted runner in {org}.
POST /orgs/{org}/actions/runners/remove-token Create a token to remove an org runner · GitHub Create a Remove Token for an Organization #
Ask an LLM
“What token do I need to unregister a self-hosted runner from my organization with the config script?”
“Can I generate a one-hour token for removing an org runner?”
Tell an agent
Create a runner remove token for organization {org}.
Generate a token to unregister a self-hosted runner from {org}.
GET /orgs/{org}/actions/runners/{runner_id} Get a self-hosted runner in an org · GitHub Get a Self-hosted Runner for an Organization #
Ask an LLM
“Is a specific self-hosted runner in my org online and busy?”
“What details does GitHub hold for one of my organization's runners?”
Tell an agent
Get self-hosted runner {runner_id} in organization {org}.
Show the status of runner {runner_id} registered to {org}.
DELETE /orgs/{org}/actions/runners/{runner_id} Force-remove a self-hosted runner from an org · GitHub Delete a Self-hosted Runner from an Organization #
Ask an LLM
“How do I remove a runner from my org when its machine no longer exists?”
“Can I force-delete an organization runner without running the config script?”
Tell an agent destructive · confirm first
Delete self-hosted runner {runner_id} from organization {org}.
Force-remove runner {runner_id} from {org}.
GET /orgs/{org}/actions/runners/{runner_id}/labels List labels on an org runner · GitHub List Labels for a Self-hosted Runner for an Organization #
Ask an LLM
“Which labels are attached to one of my organization's self-hosted runners?”
“What labels can workflows target on a given org runner?”
Tell an agent
List labels on self-hosted runner {runner_id} in organization {org}.
Show all labels for runner {runner_id} in {org}.
POST /orgs/{org}/actions/runners/{runner_id}/labels Add custom labels to an org runner · GitHub Add Custom Labels to a Self-hosted Runner for an Organization #
Ask an LLM
“How do I tag an org self-hosted runner with extra labels like gpu?”
“Can I append custom labels to a runner without losing the ones it already has?”
Tell an agent
Add labels {labels} to self-hosted runner {runner_id} in organization {org}.
Tag runner {runner_id} in {org} with {labels}.
PUT /orgs/{org}/actions/runners/{runner_id}/labels Replace custom labels on an org runner · GitHub Set Custom Labels for a Self-hosted Runner for an Organization #
Ask an LLM
“Can I wipe an org runner's custom labels and set a fresh list in one call?”
“How do I overwrite all custom labels on a runner in my organization?”
Tell an agent
Replace the custom labels on runner {runner_id} in organization {org} with {labels}.
Set runner {runner_id} in {org} to have exactly the custom labels {labels}.
DELETE /orgs/{org}/actions/runners/{runner_id}/labels Clear all custom labels from an org runner · GitHub Remove All Custom Labels from a Self-hosted Runner for an Organization #
Ask an LLM
“How do I strip every custom label from an org runner and keep only the built-in ones?”
“Which labels remain after clearing custom labels from a runner?”
Tell an agent destructive · confirm first
Remove all custom labels from runner {runner_id} in organization {org}.
Clear custom labels on self-hosted runner {runner_id} in {org}.
DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name} Remove one custom label from an org runner · GitHub Remove a Custom Label from a Self-hosted Runner for an Organization #
Ask an LLM
“Can I delete just one custom label from an org runner?”
“What happens if I try to remove a label an org runner doesn't have?”
Tell an agent destructive · confirm first
Remove the label {name} from runner {runner_id} in organization {org}.
Untag runner {runner_id} in {org} from label {name}.
GET /orgs/{org}/actions/secrets List Actions secrets in an org · GitHub List Organization Secrets #
Ask an LLM
“Which Actions secrets are defined at my organization level?”
“Can I see my org's secret names without exposing their values?”
Tell an agent
List Actions secrets in organization {org}.
Show page {page} of org secrets for {org}.
GET /orgs/{org}/actions/secrets/public-key Get the org public key for encrypting secrets · GitHub Get an Organization Public Key #
Ask an LLM
“Which public key do I need to encrypt an organization Actions secret before saving it?”
“Where do I get the key_id to send with a new org secret?”
Tell an agent
Get the Actions secrets public key for organization {org}.
Fetch the encryption key for creating secrets in {org}.
GET /orgs/{org}/actions/secrets/{secret_name} Get an org Actions secret's metadata · GitHub Get an Organization Secret #
Ask an LLM
“When was an organization secret last updated and who can see it?”
“What visibility does a specific org secret have?”
Tell an agent
Get organization secret {secret_name} in {org}.
Show the visibility and update time of secret {secret_name} in organization {org}.
PUT /orgs/{org}/actions/secrets/{secret_name} Create or update an org Actions secret · GitHub Create or Update an Organization Secret #
Ask an LLM
“How do I add an encrypted secret that all repos in my organization can use?”
“Can I share an org secret with only private repositories?”
Tell an agent
Save org secret {secret_name} in {org} with encrypted value {encrypted_value} and {visibility} visibility.
Create secret {secret_name} in organization {org} visible to repositories {selected_repository_ids}.
DELETE /orgs/{org}/actions/secrets/{secret_name} Delete an org Actions secret · GitHub Delete an Organization Secret #
Ask an LLM
“How do I delete an Actions secret from my organization?”
“Can I remove an org-level secret that repositories no longer need?”
Tell an agent destructive · confirm first
Delete organization secret {secret_name} from {org}.
Remove the {secret_name} Actions secret in organization {org}.
GET /orgs/{org}/actions/secrets/{secret_name}/repositories List repos that can use an org secret · GitHub List Selected Repositories for an Organization Secret #
Ask an LLM
“Which repositories can read an organization secret shared with selected repos?”
“What repos is my org secret currently exposed to?”
Tell an agent
List repositories that can use org secret {secret_name} in {org}.
Show page {page} of repos selected for secret {secret_name} in organization {org}.
PUT /orgs/{org}/actions/secrets/{secret_name}/repositories Replace the repos that can use an org secret · GitHub Set Selected Repositories for an Organization Secret #
Ask an LLM
“Can I reset the entire list of repos that get an organization secret?”
“How do I overwrite which selected repositories an org secret is shared with?”
Tell an agent
Replace the repos for org secret {secret_name} in {org} with {selected_repository_ids}.
Share secret {secret_name} in organization {org} with only repositories {selected_repository_ids}.
PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id} Share an org secret with one more repo · GitHub Add Selected Repository to an Organization Secret #
Ask an LLM
“How do I give one additional repository access to an org secret?”
“Can I add a repo to an org secret without redoing the whole list?”
Tell an agent
Add repository {repository_id} to org secret {secret_name} in {org}.
Share secret {secret_name} in organization {org} with repo {repository_id}.
DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id} Unshare an org secret from one repo · GitHub Remove Selected Repository from an Organization Secret #
Ask an LLM
“How do I stop one repository from reading an organization secret?”
“Can I revoke a single repo's access to an org secret?”
Tell an agent destructive · confirm first
Remove repository {repository_id} from org secret {secret_name} in {org}.
Revoke repo {repository_id}'s access to secret {secret_name} in organization {org}.
GET /orgs/{org}/actions/variables List Actions variables in an org · GitHub List Organization Variables #
Ask an LLM
“Which configuration variables are defined for Actions at my organization level?”
“Can I see the values of all my org's Actions variables?”
Tell an agent
List Actions variables in organization {org}.
Show page {page} of org variables for {org}.
POST /orgs/{org}/actions/variables Create an org Actions variable · GitHub Create an Organization Variable #
Ask an LLM
“How do I add a plain-text configuration variable that workflows across my org can read?”
“Can an org variable be limited to selected repositories?”
Tell an agent
Create org variable {name} in {org} with value {value} and {visibility} visibility.
Add variable {name}={value} to organization {org} for repositories {selected_repository_ids}, visibility {visibility}.
GET /orgs/{org}/actions/variables/{name} Get an org Actions variable · GitHub Get an Organization Variable #
Ask an LLM
“What value is an organization Actions variable currently set to?”
“Which repositories can see a specific org variable?”
Tell an agent
Get organization variable {name} in {org}.
Show the value and visibility of variable {name} in organization {org}.
PATCH /orgs/{org}/actions/variables/{name} Update an org Actions variable · GitHub Update an Organization Variable #
Ask an LLM
“Can I change the value of an existing organization variable?”
“How do I rename an org variable or change which repos see it?”
Tell an agent
Update org variable {name} in {org} to value {value}.
Rename organization variable {name} in {org} to {new_name}.
DELETE /orgs/{org}/actions/variables/{name} Delete an org Actions variable · GitHub Delete an Organization Variable #
Ask an LLM
“How do I delete a configuration variable from my organization?”
“Can I remove an org-level Actions variable by name?”
Tell an agent destructive · confirm first
Delete organization variable {name} from {org}.
Remove the {name} Actions variable in organization {org}.
GET /orgs/{org}/actions/variables/{name}/repositories List repos that can use an org variable · GitHub List Selected Repositories for an Organization Variable #
Ask an LLM
“Which repositories can read an org variable that's shared with selected repos?”
“What repos currently have access to one of my organization's variables?”
Tell an agent
List repositories that can use org variable {name} in {org}.
Show page {page} of repos selected for variable {name} in organization {org}.
PUT /orgs/{org}/actions/variables/{name}/repositories Replace the repos that can use an org variable · GitHub Set Selected Repositories for an Organization Variable #
Ask an LLM
“Can I overwrite the full list of repositories that see an org variable?”
“How do I reset which selected repos an organization variable is shared with?”
Tell an agent
Replace the repos for org variable {name} in {org} with {selected_repository_ids}.
Share variable {name} in organization {org} with only repositories {selected_repository_ids}.
PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id} Share an org variable with one more repo · GitHub Add Selected Repository to an Organization Variable #
Ask an LLM
“How do I let one more repository read an organization variable?”
“Can I add a single repo to an org variable's selected list?”
Tell an agent
Add repository {repository_id} to org variable {name} in {org}.
Share variable {name} in organization {org} with repo {repository_id}.
DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id} Unshare an org variable from one repo · GitHub Remove Selected Repository from an Organization Variable #
Ask an LLM
“How do I stop one repo from seeing an organization variable?”
“Can I revoke a single repository's access to an org variable?”
Tell an agent destructive · confirm first
Remove repository {repository_id} from org variable {name} in {org}.
Revoke repo {repository_id}'s access to variable {name} in organization {org}.
GET /repos/{owner}/{repo}/actions/artifacts List workflow artifacts in a repository · GitHub List Artifacts for a Repository #
Ask an LLM
“What build artifacts have my workflows uploaded across a repository?”
“Can I find all artifacts in a repo with a particular name?”
Tell an agent
List workflow artifacts in {owner}/{repo}.
Find artifacts named {name} across all runs in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id} Get a workflow artifact · GitHub Get an Artifact #
Ask an LLM
“How big is a specific workflow artifact and when does it expire?”
“Has a particular build artifact already expired?”
Tell an agent
Get artifact {artifact_id} in {owner}/{repo}.
Show the size and expiry of artifact {artifact_id} from {owner}/{repo}.
DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id} Delete a workflow artifact · GitHub Delete an Artifact #
Ask an LLM
“How do I delete a build artifact to free up Actions storage?”
“Can I remove one specific artifact from a workflow run?”
Tell an agent destructive · confirm first
Delete artifact {artifact_id} from {owner}/{repo}.
Remove workflow artifact {artifact_id} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format} Download a workflow artifact archive · GitHub Download an Artifact #
Ask an LLM
“How do I download the zip of an artifact my workflow produced?”
“How long is the artifact download link valid for?”
Tell an agent
Download artifact {artifact_id} from {owner}/{repo} as {archive_format}.
Get the {archive_format} download link for artifact {artifact_id} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/cache/usage Check Actions cache usage for a repository · GitHub Get GitHub Actions Cache Usage for a Repository #
Ask an LLM
“How much Actions cache is a single repository using?”
“What's the active cache count and size for one of my repos?”
Tell an agent
Show Actions cache usage for {owner}/{repo}.
Tell me how many caches {owner}/{repo} has and their total size.
GET /repos/{owner}/{repo}/actions/cache/usage-policy Get a repository's Actions cache size limit · GitHub Get GitHub Actions Cache Usage Policy for a Repository #
Ask an LLM
“What Actions cache size limit applies to my repository?”
“Is my repo's cache limit higher than the default?”
Tell an agent
Look up the cache size policy set on repository {owner}/{repo}.
Show the cache size limit in GB configured for {owner}/{repo}.
PATCH /repos/{owner}/{repo}/actions/cache/usage-policy Set a repository's Actions cache size limit · GitHub Set GitHub Actions Cache Usage Policy for a Repository #
Ask an LLM
“Can I give one repository more Actions cache space than the default?”
“How do I change the cache size limit for a single repo?”
Tell an agent
Set the Actions cache limit for {owner}/{repo} to {repo_cache_size_limit_in_gb} GB.
Change {owner}/{repo}'s cache size limit to {repo_cache_size_limit_in_gb} GB.
GET /repos/{owner}/{repo}/actions/caches List Actions caches in a repository · GitHub List GitHub Actions Caches for a Repository #
Ask an LLM
“Which Actions caches exist in my repo, and which were used most recently?”
“Can I filter a repository's caches by branch ref or key prefix?”
Tell an agent
List Actions caches in {owner}/{repo}.
Show caches in {owner}/{repo} for ref {ref} whose key starts with {key}, sorted by {sort}.
DELETE /repos/{owner}/{repo}/actions/caches Delete Actions caches by key · GitHub Delete GitHub Actions Caches for a Repository (using a Cache Key) #
Ask an LLM
“How do I delete every cache that matches a given cache key?”
“Can I clear caches for one key on a single branch only?”
Tell an agent destructive · confirm first
Delete Actions caches with key {key} in {owner}/{repo}.
Clear caches with key {key} on ref {ref} in {owner}/{repo}.
DELETE /repos/{owner}/{repo}/actions/caches/{cache_id} Delete one Actions cache by ID · GitHub Delete a GitHub Actions Cache for a Repository (using a Cache ID) #
Ask an LLM
“Can I delete a single Actions cache entry using its ID?”
“What's the way to remove one specific cache when I know its cache ID?”
Tell an agent destructive · confirm first
Delete Actions cache {cache_id} from {owner}/{repo}.
Remove the cache with ID {cache_id} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/jobs/{job_id} Get a job from a workflow run · GitHub Get a Job for a Workflow Run #
Ask an LLM
“Which step did a specific job fail on, and how long did it take?”
“What runner did a particular Actions job execute on?”
Tell an agent
Get job {job_id} in {owner}/{repo}.
Show the steps and status of workflow job {job_id} from {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs Download logs for a single job · GitHub Download Job Logs for a Workflow Run #
Ask an LLM
“How do I get the plain-text log for one job instead of the whole run?”
“Where can I download the output of a single failing Actions job?”
Tell an agent
Download the logs for job {job_id} in {owner}/{repo}.
Get the plain-text log link for workflow job {job_id} in {owner}/{repo}.
POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun Re-run one job and its dependents · GitHub Re-run a Job from a Workflow Run #
Ask an LLM
“Can I re-run just one job from a workflow run instead of the entire workflow?”
“How do I retry a single job with debug logging turned on?”
Tell an agent
Re-run job {job_id} in {owner}/{repo}.
Re-run job {job_id} in {owner}/{repo} with debug logging set to {enable_debug_logging}.
GET /repos/{owner}/{repo}/actions/oidc/customization/sub Get a repo's OIDC subject claim template · GitHub Get the Customization Template for an OIDC Subject Claim for a Repository #
Ask an LLM
“What claim keys make up my repository's OIDC token subject?”
“Is my repo using the default OIDC subject claim or a custom one?”
Tell an agent
Get the OIDC subject claim template for {owner}/{repo}.
Show whether {owner}/{repo} uses a custom OIDC sub claim.
PUT /repos/{owner}/{repo}/actions/oidc/customization/sub Customize a repo's OIDC subject claim · GitHub Set the Customization Template for an OIDC Subject Claim for a Repository #
Ask an LLM
“How do I change which claims appear in the OIDC subject for my repo's workflows?”
“Can I opt a repository back into the default OIDC subject format?”
Tell an agent
Set the OIDC subject claim for {owner}/{repo} to use default {use_default}.
Customize the OIDC sub claim in {owner}/{repo} to include keys {include_claim_keys}, use default {use_default}.
GET /repos/{owner}/{repo}/actions/organization-secrets List org secrets shared with a repo · GitHub List Repository Organization Secrets #
Ask an LLM
“Which organization-level secrets can my repository's workflows use?”
“What org secrets has my org shared into this repo?”
Tell an agent
List organization secrets shared with {owner}/{repo}.
Show which org-level secrets {owner}/{repo} inherits.
GET /repos/{owner}/{repo}/actions/organization-variables List org variables shared with a repo · GitHub List Repository Organization Variables #
Ask an LLM
“Which organization variables are available to my repository?”
“What org-level configuration variables does this repo inherit?”
Tell an agent
List organization variables shared with {owner}/{repo}.
Show the org-level variables {owner}/{repo} can read.
GET /repos/{owner}/{repo}/actions/permissions Get the Actions permissions for a repository · GitHub Get GitHub Actions Permissions for a Repository #
Ask an LLM
“Is GitHub Actions turned on for my repository, and which actions may run?”
“Does this repo allow all actions or only selected ones?”
Tell an agent
Check if repository {owner}/{repo} has Actions enabled and which actions it allows.
Check whether Actions is enabled in {owner}/{repo}.
PUT /repos/{owner}/{repo}/actions/permissions Enable or restrict Actions for a repository · GitHub Set GitHub Actions Permissions for a Repository #
Ask an LLM
“How do I turn GitHub Actions off entirely for one repository?”
“Can I limit a repo to local actions only?”
Tell an agent
Set Actions enabled to {enabled} for {owner}/{repo}.
Enable Actions in {owner}/{repo} and allow {allowed_actions} actions, enabled {enabled}.
GET /repos/{owner}/{repo}/actions/permissions/access Get outside workflow access to a private repo · GitHub Get the Level of Access for Workflows Outside of the Repository #
Ask an LLM
“Can workflows in other repositories use the actions stored in my private repo?”
“What access level do outside workflows have to this repo's reusable workflows?”
Tell an agent
Get the access level other workflows have to {owner}/{repo}.
Show whether workflows outside {owner}/{repo} can use its actions.
PUT /repos/{owner}/{repo}/actions/permissions/access Share a private repo's actions with other repos · GitHub Set the Level of Access for Workflows Outside of the Repository #
Ask an LLM
“How do I let other repos in my organization use actions from my private repository?”
“Can I share a repo's reusable workflows with the whole enterprise?”
Tell an agent
Set outside workflow access to {owner}/{repo} to {access_level}.
Share the actions in {owner}/{repo} at the {access_level} access level.
GET /repos/{owner}/{repo}/actions/permissions/selected-actions Get the allowed actions list for a repository · GitHub Get Allowed Actions for a Repository #
Ask an LLM
“Which actions patterns are allowlisted in my repository?”
“Does this repo permit GitHub-owned actions?”
Tell an agent
Show which actions repository {owner}/{repo} has allowlisted.
List the action patterns permitted to run in {owner}/{repo}.
PUT /repos/{owner}/{repo}/actions/permissions/selected-actions Set the allowed actions list for a repository · GitHub Set Allowed Actions for a Repository #
Ask an LLM
“How do I allowlist a few specific actions for just one repository?”
“Can I block GitHub-owned actions in a single repo?”
Tell an agent
Allow actions matching {patterns_allowed} in {owner}/{repo}.
Set GitHub-owned actions allowed to {github_owned_allowed} and patterns to {patterns_allowed} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/permissions/workflow Get default GITHUB_TOKEN permissions for a repo · GitHub Get Default Workflow Permissions for a Repository #
Ask an LLM
“What does GITHUB_TOKEN get by default in my repository's workflows?”
“Can workflows in this particular repo approve pull requests?”
Tell an agent
Show what the GITHUB_TOKEN can do by default in repository {owner}/{repo}.
Check whether Actions may approve pull requests in {owner}/{repo}.
PUT /repos/{owner}/{repo}/actions/permissions/workflow Set default GITHUB_TOKEN permissions for a repo · GitHub Set Default Workflow Permissions for a Repository #
Ask an LLM
“How can I give GITHUB_TOKEN write access by default in a single repo?”
“Can I allow Actions to approve pull requests in one repository only?”
Tell an agent
Give the GITHUB_TOKEN in repository {owner}/{repo} {default_workflow_permissions} access by default.
Update repository {owner}/{repo} so Actions pull request approval is {can_approve_pull_request_reviews}.
GET /repos/{owner}/{repo}/actions/runners List self-hosted runners in a repository · GitHub List Self-hosted Runners for a Repository #
Ask an LLM
“Which self-hosted runners are registered directly to my repository?”
“Are any repo-level runners offline right now?”
Tell an agent
List self-hosted runners in {owner}/{repo}.
Show page {page} of repo runners for {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runners/downloads List runner app downloads for a repository · GitHub List Runner Applications for a Repository #
Ask an LLM
“Where can I download the runner software to add a runner to one repo?”
“What runner binaries are available for setting up a repository runner?”
Tell an agent
List runner application downloads for {owner}/{repo}.
Fetch download links for the runner software for repository {owner}/{repo}.
POST /repos/{owner}/{repo}/actions/runners/registration-token Create a token to register a repo runner · GitHub Create a Registration Token for a Repository #
Ask an LLM
“How do I get a token to register a self-hosted runner to a single repository?”
“Does a repository runner registration token expire?”
Tell an agent
Issue a one-hour registration token for adding a runner to repository {owner}/{repo}.
Generate a token to configure a new self-hosted runner in {owner}/{repo}.
POST /repos/{owner}/{repo}/actions/runners/remove-token Create a token to remove a repo runner · GitHub Create a Remove Token for a Repository #
Ask an LLM
“What token does the config script need to unregister a runner from my repo?”
“Can I generate a token for removing a repository runner cleanly?”
Tell an agent
Issue a one-hour remove token for a runner in repository {owner}/{repo}.
Get a token the config script can use to deregister a runner from repository {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runners/{runner_id} Get a self-hosted runner in a repository · GitHub Get a Self-hosted Runner for a Repository #
Ask an LLM
“Is a specific repository runner online and currently running a job?”
“What operating system is one of my repo's runners on?”
Tell an agent
Get self-hosted runner {runner_id} in {owner}/{repo}.
Show the status of repo runner {runner_id} in {owner}/{repo}.
DELETE /repos/{owner}/{repo}/actions/runners/{runner_id} Force-remove a self-hosted runner from a repo · GitHub Delete a Self-hosted Runner from a Repository #
Ask an LLM
“How do I remove a repository runner whose machine is gone?”
“Can I force-delete a runner registered to a single repo?”
Tell an agent destructive · confirm first
Delete self-hosted runner {runner_id} from {owner}/{repo}.
Force-remove runner {runner_id} from repository {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels List labels on a repo runner · GitHub List Labels for a Self-hosted Runner for a Repository #
Ask an LLM
“Which labels does one of my repository's runners carry?”
“What labels can my repo's workflows use to target a specific runner?”
Tell an agent
List labels on runner {runner_id} in {owner}/{repo}.
Show the labels repository runner {runner_id} in {owner}/{repo} carries.
POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels Add custom labels to a repo runner · GitHub Add Custom Labels to a Self-hosted Runner for a Repository #
Ask an LLM
“How do I add an extra label to a runner registered to my repository?”
“Can I append labels to a repo runner without removing existing ones?”
Tell an agent
Add labels {labels} to runner {runner_id} in {owner}/{repo}.
Tag repo runner {runner_id} in {owner}/{repo} with {labels}.
PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels Replace custom labels on a repo runner · GitHub Set Custom Labels for a Self-hosted Runner for a Repository #
Ask an LLM
“Can I replace all custom labels on a repository runner with a new set?”
“How do I overwrite a repo runner's labels in one call?”
Tell an agent
Replace custom labels on runner {runner_id} in {owner}/{repo} with {labels}.
Set repo runner {runner_id} in {owner}/{repo} to exactly the labels {labels}.
DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels Clear all custom labels from a repo runner · GitHub Remove All Custom Labels from a Self-hosted Runner for a Repository #
Ask an LLM
“How do I reset a repository runner to only its built-in labels?”
“Can I strip every custom label from a runner in my repo at once?”
Tell an agent destructive · confirm first
Strip every custom label off repository runner {runner_id} in {owner}/{repo}.
Clear the custom labels on repo runner {runner_id} in {owner}/{repo}.
DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name} Remove one custom label from a repo runner · GitHub Remove a Custom Label from a Self-hosted Runner for a Repository #
Ask an LLM
“Can I take a single custom label off a repository runner?”
“What labels are left after I remove one from a repo runner?”
Tell an agent destructive · confirm first
Remove label {name} from runner {runner_id} in {owner}/{repo}.
Untag repo runner {runner_id} in {owner}/{repo} from label {name}.
GET /repos/{owner}/{repo}/actions/runs List workflow runs across a repository · GitHub List Workflow Runs for a Repository #
Ask an LLM
“Which workflow runs failed in my repository this week, across all workflows?”
“Can I filter a repo's workflow runs by branch, actor or triggering event?”
Tell an agent
List all workflow runs in {owner}/{repo}.
Show runs in {owner}/{repo} on branch {branch} with status {status}.
GET /repos/{owner}/{repo}/actions/runs/{run_id} Get a workflow run · GitHub Get a Workflow Run #
Ask an LLM
“What's the status and conclusion of a specific workflow run?”
“Which commit and branch triggered a particular run?”
Tell an agent
Get workflow run {run_id} in {owner}/{repo}.
Show the conclusion of run {run_id} in {owner}/{repo}.
DELETE /repos/{owner}/{repo}/actions/runs/{run_id} Delete a workflow run · GitHub Delete a Workflow Run #
Ask an LLM
“How do I delete an old workflow run from my repository's history?”
“Can I remove a single run from the Actions tab?”
Tell an agent destructive · confirm first
Delete workflow run {run_id} from {owner}/{repo}.
Remove run {run_id} in {owner}/{repo} from the run history.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals Get the approval history for a workflow run · GitHub Get the Review History for a Workflow Run #
Ask an LLM
“Who approved or rejected the deployment gates on a workflow run?”
“Can I see the review comments left on a run's environment approvals?”
Tell an agent
Show the review history for workflow run {run_id} in {owner}/{repo}.
List who approved deployments for run {run_id} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts List artifacts from a workflow run · GitHub List Workflow Run Artifacts #
Ask an LLM
“Which artifacts did one particular workflow run upload?”
“Can I find an artifact by name within a single run?”
Tell an agent
List the artifacts from run {run_id} in {owner}/{repo}.
Find artifact {name} produced by run {run_id} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number} Get a specific attempt of a workflow run · GitHub Get a Workflow Run Attempt #
Ask an LLM
“How did the second attempt of a re-run workflow turn out?”
“Can I look at one specific retry of a workflow run?”
Tell an agent
Get attempt {attempt_number} of run {run_id} in {owner}/{repo}.
Show the result of workflow run {run_id} attempt {attempt_number} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs List jobs in a workflow run attempt · GitHub List Jobs for a Workflow Run Attempt #
Ask an LLM
“Which jobs ran during one specific attempt of a workflow run?”
“Can I see job results for an earlier retry, not the latest one?”
Tell an agent
List jobs for attempt {attempt_number} of run {run_id} in {owner}/{repo}.
Show page {page} of jobs in run {run_id} attempt {attempt_number} for {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs Download logs for a workflow run attempt · GitHub Download Workflow Run Attempt Logs #
Ask an LLM
“How do I download the logs from a previous attempt of a workflow run?”
“Can I get the log archive for a single retry of a run?”
Tell an agent
Download logs for attempt {attempt_number} of run {run_id} in {owner}/{repo}.
Get the log archive link for run {run_id} attempt {attempt_number} in {owner}/{repo}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel Cancel a workflow run · GitHub Cancel a Workflow Run #
Ask an LLM
“How do I stop a workflow run that is stuck or no longer needed?”
“Can I cancel an in-progress Actions run from the API?”
Tell an agent destructive · confirm first
Cancel workflow run {run_id} in {owner}/{repo}.
Stop the in-progress run {run_id} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs List jobs in a workflow run · GitHub List Jobs for a Workflow Run #
Ask an LLM
“Which jobs in my latest workflow run failed?”
“Can I list jobs from every attempt of a run, not just the most recent?”
Tell an agent
List the jobs in workflow run {run_id} in {owner}/{repo}.
Show jobs for run {run_id} in {owner}/{repo} using filter {filter}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs Download all logs for a workflow run · GitHub Download Workflow Run Logs #
Ask an LLM
“How do I download the full log archive for a workflow run?”
“Is the run log download URL time-limited?”
Tell an agent
Download the logs for workflow run {run_id} in {owner}/{repo}.
Fetch the zipped logs of every job in workflow run {run_id} of {owner}/{repo}.
DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs Delete all logs for a workflow run · GitHub Delete Workflow Run Logs #
Ask an LLM
“Can I wipe the logs of a run that accidentally printed a secret?”
“How do I delete a workflow run's logs but keep the run itself?”
Tell an agent destructive · confirm first
Delete all logs for workflow run {run_id} in {owner}/{repo}.
Purge the logs of run {run_id} in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments List deployments waiting on approval for a run · GitHub Get Pending Deployments for a Workflow Run #
Ask an LLM
“Which environments is my workflow run waiting on approval for?”
“Can I see the pending deployment gates holding up a run?”
Tell an agent
Show pending deployments for workflow run {run_id} in {owner}/{repo}.
List environments awaiting approval in run {run_id} of {owner}/{repo}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments Approve or reject pending deployments for a run · GitHub Review Pending Deployments for a Workflow Run #
Ask an LLM
“How do I approve a deployment that's waiting on me as a required reviewer?”
“Can I reject a pending production deployment with a comment?”
Tell an agent
Mark pending deployments to environments {environment_ids} in run {run_id} of {owner}/{repo} as {state} with comment {comment}.
Approve environments {environment_ids} for run {run_id} in {owner}/{repo}, set state {state}, and note {comment}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun Re-run an entire workflow run · GitHub Re-run a Workflow #
Ask an LLM
“How do I re-run a whole workflow run from the start?”
“Can I re-run a workflow with debug logging enabled?”
Tell an agent
Re-run workflow run {run_id} in {owner}/{repo}.
Re-run all jobs of run {run_id} in {owner}/{repo} with debug logging {enable_debug_logging}.
POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs Re-run only the failed jobs of a run · GitHub Re-run Failed Jobs from a Workflow Run #
Ask an LLM
“Can I retry just the jobs that failed in a workflow run?”
“What's the way to re-run failed jobs and their dependents without redoing the passing ones?”
Tell an agent
Re-run the failed jobs in run {run_id} of {owner}/{repo}.
Retry failed jobs of run {run_id} in {owner}/{repo} with debug logging {enable_debug_logging}.
GET /repos/{owner}/{repo}/actions/secrets List Actions secrets in a repository · GitHub List Repository Secrets #
Ask an LLM
“Which Actions secrets are defined on my repository?”
“Can I see a repo's secret names and when they were updated?”
Tell an agent
List Actions secrets in {owner}/{repo}.
Show page {page} of repository secrets for {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/secrets/public-key Get the repo public key for encrypting secrets · GitHub Get a Repository Public Key #
Ask an LLM
“Which key do I use to encrypt a repository secret before uploading it?”
“Where do I get the key_id for a new repo secret?”
Tell an agent
Get the public key for repository {owner}/{repo} so I can encrypt a secret.
Look up the key_id and key for repo-level secrets in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/secrets/{secret_name} Get a repo Actions secret's metadata · GitHub Get a Repository Secret #
Ask an LLM
“When was a repository secret last changed?”
“Does a secret with a given name exist on my repo?”
Tell an agent
Get repository secret {secret_name} in {owner}/{repo}.
Show when secret {secret_name} in {owner}/{repo} was last updated.
PUT /repos/{owner}/{repo}/actions/secrets/{secret_name} Create or update a repo Actions secret · GitHub Create or Update a Repository Secret #
Ask an LLM
“How do I add an encrypted deploy key as a secret on my repository?”
“Can I rotate the value of an existing repo secret?”
Tell an agent
Save repo secret {secret_name} in {owner}/{repo} with encrypted value {encrypted_value}.
Set secret {secret_name} in {owner}/{repo} to {encrypted_value} encrypted with key {key_id}.
DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name} Delete a repo Actions secret · GitHub Delete a Repository Secret #
Ask an LLM
“How do I remove an Actions secret from my repository?”
“Can I delete a repo secret that's no longer used?”
Tell an agent destructive · confirm first
Delete repository secret {secret_name} from {owner}/{repo}.
Remove the {secret_name} secret in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/variables List Actions variables in a repository · GitHub List Repository Variables #
Ask an LLM
“Which configuration variables are defined on my repository?”
“What values do my repo's Actions variables hold?”
Tell an agent
List Actions variables in {owner}/{repo}.
Show page {page} of repository variables for {owner}/{repo}.
POST /repos/{owner}/{repo}/actions/variables Create a repo Actions variable · GitHub Create a Repository Variable #
Ask an LLM
“How do I add a plain-text configuration variable to a single repository?”
“Can I store a non-secret setting for my repo's workflows to read?”
Tell an agent
Create repo variable {name} with value {value} in {owner}/{repo}.
Add variable {name}={value} to {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/variables/{name} Get a repo Actions variable · GitHub Get a Repository Variable #
Ask an LLM
“What's the current value of a variable on my repository?”
“When was a repo variable last updated?”
Tell an agent
Get repository variable {name} in {owner}/{repo}.
Show the value of variable {name} in {owner}/{repo}.
PATCH /repos/{owner}/{repo}/actions/variables/{name} Update a repo Actions variable · GitHub Update a Repository Variable #
Ask an LLM
“Can I change the value of an existing repository variable?”
“How do I rename a variable on my repo?”
Tell an agent
Update repo variable {name} in {owner}/{repo} to value {value}.
Rename repository variable {name} in {owner}/{repo} to {new_name}.
DELETE /repos/{owner}/{repo}/actions/variables/{name} Delete a repo Actions variable · GitHub Delete a Repository Variable #
Ask an LLM
“How do I delete a configuration variable from my repo?”
“Can I remove a repository variable by name?”
Tell an agent destructive · confirm first
Delete repository variable {name} from {owner}/{repo}.
Remove the {name} variable in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/workflows List workflows in a repository · GitHub List Repository Workflows #
Ask an LLM
“Which workflows are defined in my repository?”
“Are any of my repo's workflows disabled?”
Tell an agent
List the workflows in {owner}/{repo}.
Show page {page} of workflow definitions in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/workflows/{workflow_id} Get a workflow · GitHub Get a Workflow #
Ask an LLM
“What state is a specific workflow in, active or disabled?”
“Can I look up a workflow by its file name like main.yaml?”
Tell an agent
Get workflow {workflow_id} in {owner}/{repo}.
Show details of the {workflow_id} workflow file in {owner}/{repo}.
PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable Disable a workflow · GitHub Disable a Workflow #
Ask an LLM
“How do I pause a workflow so it stops running on new events?”
“Can I turn off a scheduled workflow without deleting its file?”
Tell an agent
Disable workflow {workflow_id} in {owner}/{repo}.
Turn off the {workflow_id} workflow in {owner}/{repo}.
POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches Manually trigger a workflow run · GitHub Create a Workflow Dispatch Event #
Ask an LLM
“How do I start a workflow_dispatch workflow from a script?”
“Can I pass inputs when manually triggering a workflow on a branch?”
Tell an agent
Trigger workflow {workflow_id} in {owner}/{repo} on {ref}.
Dispatch {workflow_id} in {owner}/{repo} on ref {ref} with inputs {inputs}.
PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable Enable a workflow · GitHub Enable a Workflow #
Ask an LLM
“How do I turn a disabled workflow back on?”
“Can I reactivate a scheduled workflow GitHub disabled for inactivity?”
Tell an agent
Enable workflow {workflow_id} in {owner}/{repo}.
Reactivate the {workflow_id} workflow in {owner}/{repo}.
GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs List runs of one workflow · GitHub List Workflow Runs for a Workflow #
Ask an LLM
“What are the recent runs of one specific workflow, like my deploy pipeline?”
“Can I see only failed runs of a single workflow on main?”
Tell an agent
List runs of workflow {workflow_id} in {owner}/{repo}.
Show only {status} runs of the {workflow_id} workflow on {branch} in {owner}/{repo}.
GET /repos/{owner}/{repo}/environments/{environment_name}/secrets List secrets in a deployment environment · GitHub List Environment Secrets #
Ask an LLM
“Which secrets are configured for my production environment?”
“Can I list an environment's secrets without revealing their values?”
Tell an agent
List secrets in environment {environment_name} of {owner}/{repo}.
Show page {page} of secrets for the {environment_name} environment in {owner}/{repo}.
GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key Get the environment public key for secrets · GitHub Get an Environment Public Key #
Ask an LLM
“Which key encrypts secrets for a specific deployment environment?”
“Where do I get the key_id before adding an environment secret?”
Tell an agent
Get the secrets public key for environment {environment_name} in {owner}/{repo}.
Look up the key that encrypts secrets for deployment environment {environment_name} in {owner}/{repo}.
GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} Get an environment secret's metadata · GitHub Get an Environment Secret #
Ask an LLM
“When was a secret in my staging environment last updated?”
“Does a given secret exist in a particular environment?”
Tell an agent
Get secret {secret_name} in environment {environment_name} of {owner}/{repo}.
Show when {secret_name} in the {environment_name} environment of {owner}/{repo} last changed.
PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} Create or update an environment secret · GitHub Create or Update an Environment Secret #
Ask an LLM
“How do I add an encrypted secret that only production deployments can use?”
“Can I rotate a secret scoped to one environment?”
Tell an agent
Save secret {secret_name} in environment {environment_name} of {owner}/{repo} with value {encrypted_value} and key {key_id}.
Rotate the {environment_name} environment secret {secret_name} in {owner}/{repo} to {encrypted_value} using key {key_id}.
DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} Delete an environment secret · GitHub Delete an Environment Secret #
Ask an LLM
“How do I remove a secret from a deployment environment?”
“Can I delete one environment's secret without touching repo secrets?”
Tell an agent destructive · confirm first
Delete secret {secret_name} from environment {environment_name} in {owner}/{repo}.
Remove {secret_name} from the {environment_name} environment of {owner}/{repo}.
GET /repos/{owner}/{repo}/environments/{environment_name}/variables List variables in a deployment environment · GitHub List Environment Variables #
Ask an LLM
“Which configuration variables does my staging environment define?”
“What values are set on a particular environment's variables?”
Tell an agent
List variables in environment {environment_name} of {owner}/{repo}.
Show page {page} of variables for the {environment_name} environment in {owner}/{repo}.
POST /repos/{owner}/{repo}/environments/{environment_name}/variables Create an environment variable · GitHub Create an Environment Variable #
Ask an LLM
“How do I add a configuration variable scoped to one deployment environment?”
“Can production and staging have different values for the same variable name?”
Tell an agent
Create variable {name} with value {value} in environment {environment_name} of {owner}/{repo}.
Add {name}={value} to the {environment_name} environment in {owner}/{repo}.
GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} Get an environment variable · GitHub Get an Environment Variable #
Ask an LLM
“What value does a variable have in a given environment?”
“When was an environment variable last changed?”
Tell an agent
Get variable {name} in environment {environment_name} of {owner}/{repo}.
Show the value of {name} in the {environment_name} environment of {owner}/{repo}.
PATCH /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} Update an environment variable · GitHub Update an Environment Variable #
Ask an LLM
“Can I change a variable's value in just one environment?”
“How do I rename a variable in a deployment environment?”
Tell an agent
Update variable {name} in environment {environment_name} of {owner}/{repo} to {value}.
Rename {name} in the {environment_name} environment of {owner}/{repo} to {new_name}.
DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} Delete an environment variable · GitHub Delete an Environment Variable #
Ask an LLM
“How do I remove a variable from one deployment environment?”
“Can I delete an environment-scoped variable by name?”
Tell an agent destructive · confirm first
Delete variable {name} from environment {environment_name} in {owner}/{repo}.
Drop the {name} variable from deployment environment {environment_name} in {owner}/{repo}.

Documentation

📖
Documentation
https://docs.github.com/en/rest/apps
📖
Documentation
https://docs.github.com/en/rest/codes-of-conduct/codes-of-conduct
📖
Documentation
https://docs.github.com/en/rest/emojis
📖
Documentation
https://docs.github.com/en/rest/gitignore
📖
Documentation
https://docs.github.com/en/rest/apps/installations
📖
Documentation
https://docs.github.com/en/rest/enterprise-admin
📖
Documentation
https://docs.github.com/en/rest/activity/events
📖
Documentation
https://docs.github.com/en/rest/orgs
📖
Documentation
https://docs.github.com/en/rest/rate-limit
📖
Documentation
https://docs.github.com/en/enterprise-cloud@latest/rest/scim
📖
Documentation
https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api
📖
Documentation
https://docs.github.com/en/rest/teams
📖
Documentation
https://docs.github.com/en/rest/meta/meta
📖
Documentation
https://docs.github.com/en/rest/actions
📖
Documentation
https://docs.github.com/en/rest/branches
📖
Documentation
https://docs.github.com/en/rest/code-scanning
📖
Documentation
https://docs.github.com/en/rest/collaborators
📖
Documentation
https://docs.github.com/en/rest/dependabot
📖
Documentation
https://docs.github.com/en/rest/webhooks
📖
Documentation
https://docs.github.com/en/rest/pulls
📖
Documentation
https://docs.github.com/en/rest/git/tags
📖
Documentation
https://docs.github.com/en/rest/repos/autolinks
📖
Documentation
https://docs.github.com/en/rest/collaborators/invitations

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-actions-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/asyncapi/github-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-repository-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-minimal-repository-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-workflow-run-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-deployment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-pending-deployment-schema.json

Other Resources

🔗
Reference
https://docs.github.com/en/webhooks/webhook-events-and-payloads

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/github-actions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

github-actions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.1.4
  title: GitHub v3 REST Actions API
  description: GitHub's v3 REST API.
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  contact:
    name: Support
    url: https://support.github.com/contact?tags=dotcom-rest-api
  x-github-plan: ghes
  x-github-release: 3.9
servers:
- url: '{protocol}://{hostname}/api/v3'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: HOSTNAME
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: http
tags:


# --- truncated at 32 KB (405 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-actions-api-openapi.yml