Operations 121
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
Ask an LLM
“Which global webhooks are configured on our GitHub Enterprise Server instance?”
“Can I page through all the instance-wide webhooks an admin has set up?”
Tell an agent
List all the global webhooks on this instance.
Show page {page} of global webhooks, {per_page} per page.
Ask an LLM
“How do I set up an instance-wide webhook that fires on user and organization events?”
“Can I create a global webhook that starts out inactive?”
Tell an agent
Create a global webhook named {name} with the config {config}.
Add a new global webhook {name} using {config} that fires on {events}.
Ask an LLM
“What events and delivery URL is a particular global webhook configured with?”
“Is a specific instance-level webhook currently active?”
Tell an agent
Get global webhook {hook_id}.
Show the config and events for global hook {hook_id}.
Ask an LLM
“How do I change which events an existing global webhook listens to?”
“Will fields I leave out reset to defaults when I edit a global webhook?”
Tell an agent
Update global webhook {hook_id} to fire on {events}.
Change the config of existing global hook {hook_id} to {config} and set active to {active}.
Ask an LLM
“How do I remove an instance-wide webhook we no longer use?”
“Can I permanently delete a global webhook from the enterprise server?”
Tell an agent destructive · confirm first
Delete global webhook {hook_id}.
Remove the instance-level webhook with ID {hook_id}.
POST
/admin/hooks/{hook_id}/pings
Send a test ping to a global webhook · GitHub Ping a Global Webhook
#
Ask an LLM
“How can I test that a global webhook's endpoint is receiving deliveries?”
“Can I trigger a ping event for an instance-wide webhook?”
Tell an agent
Ping global webhook {hook_id}.
Send a test ping event to global hook {hook_id} to confirm delivery works.
Ask an LLM
“Which user SSH public keys exist on our enterprise instance?”
“Can I see only the public keys that have been used since a certain date?”
Tell an agent
List all public keys on the instance.
Show public keys accessed since {since}, sorted by {sort}.
Ask an LLM
“As a site admin, how do I revoke a compromised SSH public key for a user?”
“Can I remove a public key from the instance by its key ID?”
Tell an agent destructive · confirm first
Delete public key {key_ids}.
Revoke the SSH public key with ID {key_ids} from the instance.
PATCH
/admin/ldap/teams/{team_id}/mapping
Map a team to an LDAP group · GitHub Update LDAP Mapping for a Team
#
Ask an LLM
“How do I link an existing team to an LDAP group's distinguished name?”
“Does LDAP sync need to be enabled before I can map a team to an LDAP entry?”
Tell an agent
Map team {team_id} to the LDAP DN {ldap_dn}.
Change the LDAP group mapping for team {team_id} to {ldap_dn}.
POST
/admin/ldap/teams/{team_id}/sync
Queue an LDAP sync for a team · GitHub Sync LDAP Mapping for a Team
#
Ask an LLM
“How do I force a team's membership to resync from LDAP?”
“Does queuing a team LDAP sync run it immediately?”
Tell an agent
Queue an LDAP sync for team {team_id}.
Resync team {team_id}'s membership from its mapped LDAP group.
PATCH
/admin/ldap/users/{username}/mapping
Map a user to an LDAP entry · GitHub Update LDAP Mapping for a User
#
Ask an LLM
“How do I point a user account at a different LDAP distinguished name?”
“Can I fix a user's LDAP DN mapping after their directory entry moved?”
Tell an agent
Map user {username} to the LDAP DN {ldap_dn}.
Update the LDAP entry that {username} is linked to so it's {ldap_dn}.
POST
/admin/ldap/users/{username}/sync
Queue an LDAP sync for a user · GitHub Sync LDAP Mapping for a User
#
Ask an LLM
“How do I refresh a single user's account details from LDAP?”
“Is a user LDAP sync performed right away or queued?”
Tell an agent
Queue an LDAP sync for user {username}.
Resync {username}'s account from the directory.
Ask an LLM
“How does a site administrator create a new organization and assign its admin?”
“Can I give a new organization a display name separate from its login?”
Tell an agent
Create organization {login} with {admin} as its admin.
Set up a new org {login} administered by {admin} and display it as {profile_name}.
Ask an LLM
“How do I change an organization's login name on the enterprise instance?”
“Can a site admin rename an existing org?”
Tell an agent
Rename organization {org} to {login}.
Change the {org} org's login to {login}.
GET
/admin/pre-receive-environments
List pre-receive hook environments · GitHub List Pre-receive Environments
#
Ask an LLM
“Which pre-receive environments are available to run hook scripts in?”
“Can I sort the list of pre-receive environments by name or creation date?”
Tell an agent
List all pre-receive environments.
Show pre-receive environments sorted by {sort} in {direction} order.
POST
/admin/pre-receive-environments
Create a pre-receive hook environment · GitHub Create a Pre-receive Environment
#
Ask an LLM
“How do I add a custom environment image for pre-receive hooks to run in?”
“What do I need to supply to register a new pre-receive environment tarball?”
Tell an agent
Create a pre-receive environment named {name} from the image at {image_url}.
Register a new hook environment {name} using tarball {image_url}.
GET
/admin/pre-receive-environments/{pre_receive_environment_id}
Get a pre-receive environment · GitHub Get a Pre-receive Environment
#
Ask an LLM
“What image URL and download state does a given pre-receive environment have?”
“How many hooks use a specific pre-receive environment?”
Tell an agent
Get pre-receive environment {pre_receive_environment_id}.
Show the full details of hook environment {pre_receive_environment_id}.
PATCH
/admin/pre-receive-environments/{pre_receive_environment_id}
Update a pre-receive environment · GitHub Update a Pre-receive Environment
#
Ask an LLM
“How do I rename a pre-receive environment or point it at a new image URL?”
“Can I edit the default pre-receive environment?”
Tell an agent
Rename pre-receive environment {pre_receive_environment_id} to {name}.
Change the image URL of hook environment {pre_receive_environment_id} to {image_url}.
DELETE
/admin/pre-receive-environments/{pre_receive_environment_id}
Delete a pre-receive environment · GitHub Delete a Pre-receive Environment
#
Ask an LLM
“How do I delete a pre-receive environment we no longer need?”
“Why can't I delete the default environment or one that hooks still use?”
Tell an agent destructive · confirm first
Delete pre-receive environment {pre_receive_environment_id}.
Remove the unused hook environment {pre_receive_environment_id}.
POST
/admin/pre-receive-environments/{pre_receive_environment_id}/downloads
Re-download a pre-receive environment image · GitHub Start a Pre-receive Environment Download
#
Ask an LLM
“How do I refresh a pre-receive environment after publishing a new tarball at its image URL?”
“Will re-downloading an environment overwrite the existing one?”
Tell an agent
Start a new download for pre-receive environment {pre_receive_environment_id}.
Trigger a fresh tarball download for hook environment {pre_receive_environment_id} from its image URL.
GET
/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest
Check a pre-receive environment download · GitHub Get the Download Status for a Pre-receive Environment
#
Ask an LLM
“Has the latest tarball download for my pre-receive environment finished or failed?”
“Can I check just the download state of a hook environment?”
Tell an agent
Get the latest download status for pre-receive environment {pre_receive_environment_id}.
Check whether hook environment {pre_receive_environment_id} finished downloading.
GET
/admin/pre-receive-hooks
List all pre-receive hooks on the instance · GitHub List Pre-receive Hooks
#
Ask an LLM
“Which pre-receive hooks are defined globally on our enterprise server?”
“Can I sort the instance's pre-receive hooks by name?”
Tell an agent
List every pre-receive hook defined at the instance level.
Show instance pre-receive hooks sorted by {sort} {direction}.
Ask an LLM
“How do I create a pre-receive hook that runs a script from a repository to block bad pushes?”
“Can I let organizations override the enforcement of a new hook?”
Tell an agent
Create a pre-receive hook {name} running {script} from {script_repository} in environment {environment}.
Add hook {name} using script {script} in {script_repository} on {environment} with enforcement {enforcement}.
GET
/admin/pre-receive-hooks/{pre_receive_hook_id}
Get a pre-receive hook's instance settings · GitHub Get a Pre-receive Hook
#
Ask an LLM
“What script and environment does a given global pre-receive hook use?”
“Is a specific pre-receive hook enforced instance-wide?”
Tell an agent
Get instance pre-receive hook {pre_receive_hook_id}.
Show the global script, environment and enforcement of hook {pre_receive_hook_id}.
PATCH
/admin/pre-receive-hooks/{pre_receive_hook_id}
Update a pre-receive hook's global settings · GitHub Update a Pre-receive Hook
#
Ask an LLM
“How do I change the script or environment a global pre-receive hook runs?”
“Can I stop orgs from overriding a hook by changing its downstream configuration setting?”
Tell an agent
Change the script of instance hook {pre_receive_hook_id} to {script}.
Set global enforcement of hook {pre_receive_hook_id} to {enforcement} and downstream configuration to {allow_downstream_configuration}.
DELETE
/admin/pre-receive-hooks/{pre_receive_hook_id}
Delete a pre-receive hook · GitHub Delete a Pre-receive Hook
#
Ask an LLM
“How do I delete a pre-receive hook entirely from the instance?”
“Can I remove a global hook definition rather than just disabling it for one org?”
Tell an agent destructive · confirm first
Delete pre-receive hook {pre_receive_hook_id} from the instance.
Permanently remove the hook definition {pre_receive_hook_id}.
Ask an LLM
“Which personal access tokens exist across every user on the instance, admins included?”
“Can a site admin audit all PATs on the server?”
Tell an agent
List personal access tokens for all users.
Show page {page} of every user's personal access tokens.
DELETE
/admin/tokens/{token_id}
Delete a user's personal access token · GitHub Delete a Personal Access Token
#
Ask an LLM
“How do I revoke someone's personal access token as a site admin?”
“Why do I get a 403 when deleting a token I'm currently using?”
Tell an agent destructive · confirm first
Delete personal access token {token_id}.
Revoke the PAT with ID {token_id}.
Ask an LLM
“How does a site admin create a new user account on the instance?”
“Can I create a user who starts out suspended?”
Tell an agent
Create user {login} with email {email}.
Add a new account {login} and set suspended to {suspended}.
Ask an LLM
“How do I rename a user's login on the enterprise server?”
“Can a site admin change someone's username for them?”
Tell an agent
Change the username of {username} to {login}.
Rename user {username} so their login becomes {login}.
Ask an LLM
“What gets removed when I delete a user account from the instance?”
“Can I delete a user account instead of suspending it?”
Tell an agent destructive · confirm first
Delete user {username} along with their repositories and gists.
Permanently remove the account {username} from the instance.
POST
/admin/users/{username}/authorizations
Create an impersonation token for a user · GitHub Create an Impersonation OAuth Token
#
Ask an LLM
“How can a site admin get an OAuth token that acts as a specific user?”
“Which scopes can I grant on an impersonation token?”
Tell an agent
Create an impersonation OAuth token for {username} with scopes {scopes}.
Issue a token to act as {username} limited to {scopes}.
DELETE
/admin/users/{username}/authorizations
Revoke a user's impersonation token · GitHub Delete an Impersonation OAuth Token
#
Ask an LLM
“How do I revoke the impersonation OAuth token I created for a user?”
“Can I clean up an impersonation token once I'm done acting as someone?”
Tell an agent destructive · confirm first
Delete the impersonation OAuth token for {username}.
Revoke my impersonation access to {username}.
GET
/enterprise/announcement
Get the global announcement banner · GitHub Get the Global Announcement Banner
#
Ask an LLM
“What does the enterprise-wide announcement banner currently say?”
“When does the current global announcement expire?”
Tell an agent
Show the current global announcement banner.
Get the announcement message and expiry date for the enterprise.
PATCH
/enterprise/announcement
Set the global announcement banner · GitHub Set the Global Announcement Banner
#
Ask an LLM
“How do I post a banner message to every user in our enterprise?”
“Can I make the global announcement expire automatically at a set time?”
Tell an agent
Set the global announcement to {announcement}.
Post the banner {announcement} and have it expire at {expires_at}.
DELETE
/enterprise/announcement
Remove the global announcement banner · GitHub Remove the Global Announcement Banner
#
Ask an LLM
“How do I take down the enterprise announcement banner early?”
“Can I clear the global banner without setting a new one?”
Tell an agent destructive · confirm first
Remove the global announcement banner.
Clear the enterprise-wide banner message now.
GET
/enterprise/settings/license
Get enterprise license information · GitHub Get License Information
#
Ask an LLM
“How many seats does our GitHub Enterprise license have and how many are used?”
“When does the enterprise license expire?”
Tell an agent
Show the enterprise license information.
Check seat usage and expiration on our license.
Ask an LLM
“Where can I get one overview of every usage statistic for the instance?”
“Can I pull repos, users, issues and pull request counts in a single call?”
Tell an agent
Get all statistics for the instance.
Give me the full usage stats overview across every category.
Ask an LLM
“How many comments have been made on commits, gists, issues and pull requests?”
“What are the comment counts across the instance?”
Tell an agent
Get comment statistics for the instance.
Show only the comment counts.
Ask an LLM
“How many gists exist on the instance, and how many are private?”
“What are the gist usage numbers?”
Tell an agent
Get gist statistics for the instance.
Show the private and public gist counts.
Ask an LLM
“How many webhooks are configured across the instance and how many are active?”
“What are the hook usage numbers?”
Tell an agent
Get hook statistics for the instance.
Show the active versus inactive webhook counts.
Ask an LLM
“How many issues are open versus closed on the instance?”
“What are the total issue counts?”
Tell an agent
Get issue statistics for the instance.
Show the open and closed issue counts.
Ask an LLM
“How many milestones are open or closed across all repositories?”
“What are the milestone totals?”
Tell an agent
Get milestone statistics for the instance.
Show the open and closed milestone counts.
Ask an LLM
“How many organizations and teams exist on the instance?”
“What are the org and team membership totals?”
Tell an agent
Get organization statistics for the instance.
Show the org, team and team member counts.
Ask an LLM
“How many GitHub Pages sites are published on the instance?”
“What are the Pages usage numbers?”
Tell an agent
Get Pages statistics for the instance.
Show how many Pages sites exist.
Ask an LLM
“How many pull requests are merged, mergeable or unmergeable on the instance?”
“What are the pull request totals?”
Tell an agent
Get pull request statistics for the instance.
Show merged and unmergeable pull request counts.
Ask an LLM
“How many repositories, forks and root repos exist on the instance?”
“What are the repository totals?”
Tell an agent
Get repository statistics for the instance.
Show the repo, fork and org-owned repository counts.
Ask an LLM
“How many users, admins and suspended accounts are on the instance?”
“What are the user account totals?”
Tell an agent
Get user statistics for the instance.
Show the admin and suspended user counts.
GET
/enterprises/{enterprise}/actions/permissions
Get an enterprise's Actions permissions policy · GitHub Get GitHub Actions Permissions for an Enterprise
#
Ask an LLM
“Which organizations in my enterprise are allowed to use GitHub Actions?”
“What is our enterprise policy on which actions can run?”
Tell an agent
Get the GitHub Actions permissions policy for enterprise {enterprise}.
Show which orgs and actions are allowed under {enterprise}'s Actions policy.
PUT
/enterprises/{enterprise}/actions/permissions
Set an enterprise's Actions permissions policy · GitHub Set GitHub Actions Permissions for an Enterprise
#
Ask an LLM
“How do I restrict GitHub Actions to only selected organizations in my enterprise?”
“Can I limit the enterprise to actions owned by GitHub or local actions only?”
Tell an agent
Set GitHub Actions for {enterprise} to enable {enabled_organizations} organizations.
Update {enterprise}'s Actions policy: organizations {enabled_organizations}, allowed actions {allowed_actions}.
GET
/enterprises/{enterprise}/actions/permissions/organizations
List orgs selected for Actions in an enterprise · GitHub List Selected Organizations Enabled for GitHub Actions in an Enterprise
#
Ask an LLM
“Which specific organizations have GitHub Actions turned on under our selected-orgs policy?”
“Can I see the org allowlist for Actions in my enterprise?”
Tell an agent
List the organizations selected to use Actions in {enterprise}.
Show page {page} of Actions-enabled orgs for {enterprise}.
PUT
/enterprises/{enterprise}/actions/permissions/organizations
Replace the orgs enabled for Actions · GitHub Set Selected Organizations Enabled for GitHub Actions in an Enterprise
#
Ask an LLM
“How do I replace the whole list of organizations allowed to use Actions in my enterprise?”
“Can I overwrite the Actions org allowlist in one call?”
Tell an agent
Set the Actions-enabled organizations for {enterprise} to exactly {selected_organization_ids}.
Replace {enterprise}'s whole Actions org allowlist with {selected_organization_ids}.
PUT
/enterprises/{enterprise}/actions/permissions/organizations/{org_id}
Enable Actions for one organization · GitHub Enable a Selected Organization for GitHub Actions in an Enterprise
#
Ask an LLM
“How do I add a single organization to the list allowed to run GitHub Actions?”
“Can I turn on Actions for one more org without resetting the others?”
Tell an agent
Enable GitHub Actions for organization {org_id} in {enterprise}.
Add org {org_id} to {enterprise}'s Actions allowlist.
DELETE
/enterprises/{enterprise}/actions/permissions/organizations/{org_id}
Disable Actions for one organization · GitHub Disable a Selected Organization for GitHub Actions in an Enterprise
#
Ask an LLM
“How do I stop a single organization from using GitHub Actions in my enterprise?”
“Can I pull one org off the Actions allowlist?”
Tell an agent destructive · confirm first
Disable GitHub Actions for organization {org_id} in {enterprise}.
Remove org {org_id} from {enterprise}'s Actions allowlist.
GET
/enterprises/{enterprise}/actions/permissions/selected-actions
Get the allowed actions for an enterprise · GitHub Get Allowed Actions for an Enterprise
#
Ask an LLM
“Which action patterns are on our enterprise's allowed-actions list?”
“Are GitHub-owned actions allowed under our selected-actions policy?”
Tell an agent
Show the allowed actions for enterprise {enterprise}.
Get the action patterns {enterprise} permits.
PUT
/enterprises/{enterprise}/actions/permissions/selected-actions
Set the allowed actions for an enterprise · GitHub Set Allowed Actions for an Enterprise
#
Ask an LLM
“How do I allow only certain third-party actions by pattern across the enterprise?”
“Can I block GitHub-owned actions while allowing specific patterns?”
Tell an agent
Allow the action patterns {patterns_allowed} in {enterprise}.
Set {enterprise}'s allowed actions to patterns {patterns_allowed} with GitHub-owned set to {github_owned_allowed}.
GET
/enterprises/{enterprise}/actions/runner-groups
List an enterprise's runner groups · GitHub List Self-hosted Runner Groups for an Enterprise
#
Ask an LLM
“What self-hosted runner groups exist in my enterprise?”
“Which runner groups can a particular organization see?”
Tell an agent
List the self-hosted runner groups for {enterprise}.
Show {enterprise} runner groups visible to organization {visible_to_organization}.
POST
/enterprises/{enterprise}/actions/runner-groups
Create an enterprise runner group · GitHub Create a Self-hosted Runner Group for an Enterprise
#
Ask an LLM
“How do I create a runner group shared by selected organizations in my enterprise?”
“Can a new runner group be restricted to specific workflows?”
Tell an agent
Create a runner group named {name} in {enterprise}.
Create runner group {name} in {enterprise} with visibility {visibility} for orgs {selected_organization_ids}.
GET
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
Get an enterprise runner group · GitHub Get a Self-hosted Runner Group for an Enterprise
#
Ask an LLM
“What visibility and workflow restrictions does a runner group have?”
“Does a given enterprise runner group allow public repositories?”
Tell an agent
Get runner group {runner_group_id} in {enterprise}.
Show the settings of {enterprise} runner group {runner_group_id}.
PATCH
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
Update an enterprise runner group · GitHub Update a Self-hosted Runner Group for an Enterprise
#
Ask an LLM
“How do I rename a runner group or change who can see it?”
“Can I lock an existing runner group down to selected workflows?”
Tell an agent
Rename {enterprise} runner group {runner_group_id} to {name}.
Change the visibility of runner group {runner_group_id} in {enterprise} to {visibility}.
DELETE
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
Delete an enterprise runner group · GitHub Delete a Self-hosted Runner Group from an Enterprise
#
Ask an LLM
“How do I delete a runner group we no longer need in our enterprise?”
“Can I remove a whole self-hosted runner group?”
Tell an agent destructive · confirm first
Delete runner group {runner_group_id} from {enterprise}.
Remove the whole {enterprise} runner group {runner_group_id}.
GET
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations
List orgs with access to a runner group · GitHub List Organization Access to a Self-hosted Runner Group in an Enterprise
#
Ask an LLM
“Which organizations can use a particular enterprise runner group?”
“How do I check who has access to a shared runner group?”
Tell an agent
List the organizations with access to runner group {runner_group_id} in {enterprise}.
Show which orgs can use {enterprise} runner group {runner_group_id}.
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations
Replace orgs with access to a runner group · GitHub Set Organization Access for a Self-hosted Runner Group in an Enterprise
#
Ask an LLM
“How do I overwrite the full list of organizations that can use a runner group?”
“Can I reset runner group access to a new set of orgs in one call?”
Tell an agent
Set the orgs with access to runner group {runner_group_id} in {enterprise} to exactly {selected_organization_ids}.
Replace the org access list on {enterprise} runner group {runner_group_id} with {selected_organization_ids}.
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
Give one org access to a runner group · GitHub Add Organization Access to a Self-hosted Runner Group in an Enterprise
#
Ask an LLM
“How do I let one more organization use an enterprise runner group?”
“Does the runner group need selected visibility before I can add an org to it?”
Tell an agent
Give organization {org_id} access to runner group {runner_group_id} in {enterprise}.
Add org {org_id} to the access list of {enterprise} runner group {runner_group_id}.
DELETE
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
Remove one org's access to a runner group · GitHub Remove Organization Access to a Self-hosted Runner Group in an Enterprise
#
Ask an LLM
“How do I stop a single organization from using a shared runner group?”
“Can I revoke one org's runner group access without touching the others?”
Tell an agent destructive · confirm first
Remove organization {org_id} from runner group {runner_group_id} in {enterprise}.
Revoke org {org_id}'s access to {enterprise} runner group {runner_group_id}.
GET
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
List runners in an enterprise runner group · GitHub List Self-hosted Runners in a Group for an Enterprise
#
Ask an LLM
“Which self-hosted runners belong to a specific enterprise runner group?”
“How many machines are in a runner group?”
Tell an agent
List the runners in group {runner_group_id} for {enterprise}.
Show which self-hosted runners are members of {enterprise} group {runner_group_id}.
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
Replace the runners in a runner group · GitHub Set Self-hosted Runners in a Group for an Enterprise
#
Ask an LLM
“How do I overwrite which runners belong to an enterprise runner group?”
“Can I set the full runner membership of a group in one call?”
Tell an agent
Set the runners in group {runner_group_id} for {enterprise} to exactly {runners}.
Replace the runner list of {enterprise} group {runner_group_id} with {runners}.
PUT
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
Add a runner to an enterprise runner group · GitHub Add a Self-hosted Runner to a Group for an Enterprise
#
Ask an LLM
“How do I move one self-hosted runner into a specific enterprise runner group?”
“Can I add a single runner to a group without resetting its members?”
Tell an agent
Add runner {runner_id} to group {runner_group_id} in {enterprise}.
Put self-hosted runner {runner_id} into {enterprise} runner group {runner_group_id}.
DELETE
/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
Remove a runner from a runner group · GitHub Remove a Self-hosted Runner from a Group for an Enterprise
#
Ask an LLM
“Where does a runner go when I take it out of an enterprise runner group?”
“How do I move a runner back to the default group?”
Tell an agent destructive · confirm first
Remove runner {runner_id} from group {runner_group_id} in {enterprise}.
Send runner {runner_id} back to the default group by taking it out of {enterprise} group {runner_group_id}.
GET
/enterprises/{enterprise}/actions/runners
List all self-hosted runners in an enterprise · GitHub List Self-hosted Runners for an Enterprise
#
Ask an LLM
“What self-hosted runners are registered across my whole enterprise?”
“Can I see every enterprise runner regardless of which group it's in?”
Tell an agent
List all self-hosted runners for {enterprise}.
Show page {page} of every runner registered to {enterprise}.
GET
/enterprises/{enterprise}/actions/runners/downloads
List runner application downloads · GitHub List Runner Applications for an Enterprise
#
Ask an LLM
“Where do I download the runner application binary to set up a self-hosted runner?”
“Which operating systems and architectures have runner downloads available?”
Tell an agent
List the runner application downloads for {enterprise}.
Get the runner binaries I can install for {enterprise}.
POST
/enterprises/{enterprise}/actions/runners/registration-token
Get a token to register an enterprise runner · GitHub Create a Registration Token for an Enterprise
#
Ask an LLM
“How do I get the token the config script needs to register a new self-hosted runner?”
“How long does a runner registration token last?”
Tell an agent
Create a runner registration token for {enterprise}.
Give me a one-hour token to register a new runner with {enterprise}.
POST
/enterprises/{enterprise}/actions/runners/remove-token
Get a token to unregister an enterprise runner · GitHub Create a Remove Token for an Enterprise
#
Ask an LLM
“What token do I pass to the config script to remove a self-hosted runner?”
“Can I get a removal token for decommissioning a runner machine?”
Tell an agent
Create a runner remove token for {enterprise}.
Get a token so I can unregister a runner from {enterprise} with the config script.
GET
/enterprises/{enterprise}/actions/runners/{runner_id}
Get an enterprise self-hosted runner · GitHub Get a Self-hosted Runner for an Enterprise
#
Ask an LLM
“Is a particular self-hosted runner online and busy?”
“What labels and OS does a given enterprise runner report?”
Tell an agent
Get self-hosted runner {runner_id} in {enterprise}.
Check the status of {enterprise} runner {runner_id}.
DELETE
/enterprises/{enterprise}/actions/runners/{runner_id}
Force-remove a self-hosted runner · GitHub Delete a Self-hosted Runner from an Enterprise
#
Ask an LLM
“How do I remove a runner whose machine no longer exists?”
“Can I force-delete a self-hosted runner from the enterprise?”
Tell an agent destructive · confirm first
Delete self-hosted runner {runner_id} from {enterprise}.
Force-remove dead runner {runner_id} from {enterprise}.
GET
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
List a runner's labels · GitHub List Labels for a Self-hosted Runner for an Enterprise
#
Ask an LLM
“What labels does a self-hosted runner have that workflows can target?”
“Which of a runner's labels are custom and which are read-only?”
Tell an agent
List the labels on runner {runner_id} in {enterprise}.
Show every label attached to {enterprise} runner {runner_id}.
POST
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
Add custom labels to a runner · GitHub Add Custom Labels to a Self-hosted Runner for an Enterprise
#
Ask an LLM
“How do I tag a self-hosted runner with extra labels like gpu without losing existing ones?”
“Can I append custom labels to an enterprise runner?”
Tell an agent
Add the labels {labels} to runner {runner_id} in {enterprise}.
Tag {enterprise} runner {runner_id} with the additional labels {labels}.
PUT
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
Replace a runner's custom labels · GitHub Set Custom Labels for a Self-hosted Runner for an Enterprise
#
Ask an LLM
“How do I replace all of a runner's custom labels with a new set?”
“Can I overwrite custom labels on a runner in one call?”
Tell an agent
Set the custom labels on runner {runner_id} in {enterprise} to exactly {labels}.
Replace every custom label on {enterprise} runner {runner_id} with {labels}.
DELETE
/enterprises/{enterprise}/actions/runners/{runner_id}/labels
Remove all custom labels from a runner · GitHub Remove All Custom Labels from a Self-hosted Runner for an Enterprise
#
Ask an LLM
“How do I strip every custom label off a runner and keep only the defaults?”
“Can I clear a runner's custom labels in one go?”
Tell an agent destructive · confirm first
Remove all custom labels from runner {runner_id} in {enterprise}.
Clear every custom label on {enterprise} runner {runner_id}, leaving the read-only ones.
DELETE
/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}
Remove one custom label from a runner · GitHub Remove a Custom Label from a Self-hosted Runner for an Enterprise
#
Ask an LLM
“How do I take a single custom label off a self-hosted runner?”
“What happens if the label I try to remove isn't on the runner?”
Tell an agent destructive · confirm first
Remove the label {name} from runner {runner_id} in {enterprise}.
Drop just the {name} custom label from {enterprise} runner {runner_id}.
GET
/enterprises/{enterprise}/audit-log
Search an enterprise's audit log · GitHub Get the Audit Log for an Enterprise
#
Ask an LLM
“Who did what across my enterprise recently, according to the audit log?”
“Can I include Git events as well as web events in the audit log?”
Tell an agent
Get the audit log for {enterprise}.
Search {enterprise}'s audit log for {phrase}, including {include} events.
GET
/enterprises/{enterprise}/code_security_and_analysis
Get an enterprise's code security defaults · GitHub Get Code Security and Analysis Features for an Enterprise
#
Ask an LLM
“Are Dependabot alerts and secret scanning turned on by default for new repos in my enterprise?”
“What are our enterprise's code security and analysis settings?”
Tell an agent
Get the code security and analysis settings for {enterprise}.
Show which security features {enterprise} enables for new repositories.
PATCH
/enterprises/{enterprise}/code_security_and_analysis
Update code security defaults for new repos · GitHub Update Code Security and Analysis Features for an Enterprise
#
Ask an LLM
“How do I turn on secret scanning push protection for every new repository in my enterprise?”
“Can I set a custom help link for developers blocked by push protection?”
Tell an agent
Enable secret scanning for new repositories in {enterprise} ({secret_scanning_enabled_for_new_repositories}).
Set Dependabot alerts on new {enterprise} repos to {dependabot_alerts_enabled_for_new_repositories}.
POST
/enterprises/{enterprise}/{security_product}/{enablement}
Enable or disable a security feature everywhere · GitHub Enable or Disable a Security Feature
#
Ask an LLM
“How do I turn on a security feature for all existing repositories in my enterprise at once?”
“Can I disable secret scanning across every repo in the enterprise?”
Tell an agent
Apply {enablement} for {security_product} on all repositories in {enterprise}.
Turn {security_product} on or off across every existing {enterprise} repo using {enablement}.
GET
/manage/v1/config/nodes
Get metadata for cluster nodes · GitHub Get GHES Node Metadata for All Nodes
#
Ask an LLM
“What nodes are configured in our GHES cluster and what roles do they have?”
“Can I look up metadata for one node by its UUID?”
Tell an agent
Get node metadata for all configured nodes.
Show config metadata for the node with UUID {uuid}.
GET
/manage/v1/replication/status
Get replica service status · GitHub Get the Status of Services Running on All Replica Nodes
#
Ask an LLM
“Are all services on our replica nodes healthy and replicating?”
“How do I check replication status for nodes with a given cluster role?”
Tell an agent
Get the replication status for all replica nodes.
Check replication service status for nodes with the role {cluster_roles}.
GET
/manage/v1/version
Get installed GHES versions per node · GitHub Get All GHES Release Versions for All Nodes
#
Ask an LLM
“Which GitHub Enterprise Server release is installed on each of our nodes?”
“Are all cluster nodes running the same GHES version?”
Tell an agent
Get the installed GHES version on all nodes.
Show the release version running on node {uuid}.
GET
/orgs/{org}/pre-receive-hooks
List pre-receive hooks for an organization · GitHub List Pre-receive Hooks for an Organization
#
Ask an LLM
“Which pre-receive hooks are enabled or testing for my organization?”
“Can I see hooks my org is allowed to configure even if they're disabled?”
Tell an agent
List the pre-receive hooks for organization {org}.
Show {org}'s org-level pre-receive hooks sorted by {sort}.
GET
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
Get a pre-receive hook for an organization · GitHub Get a Pre-receive Hook for an Organization
#
Ask an LLM
“How is a particular pre-receive hook enforced within my organization?”
“Does my org override the global setting for a hook?”
Tell an agent
Get pre-receive hook {pre_receive_hook_id} for organization {org}.
Show the org-level enforcement of hook {pre_receive_hook_id} in {org}.
PATCH
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
Set a pre-receive hook's enforcement for an org · GitHub Update Pre-receive Hook Enforcement for an Organization
#
Ask an LLM
“How do I switch a pre-receive hook to testing mode just for my organization?”
“Can my org let its repositories override a hook's enforcement?”
Tell an agent
Set enforcement of hook {pre_receive_hook_id} in organization {org} to {enforcement}.
Let repos in {org} configure hook {pre_receive_hook_id} themselves ({allow_downstream_configuration}).
DELETE
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}
Clear an org's pre-receive hook override · GitHub Remove Pre-receive Hook Enforcement for an Organization
#
Ask an LLM
“How do I make my organization fall back to the global setting for a pre-receive hook?”
“Can I remove an org-level override on a hook?”
Tell an agent destructive · confirm first
Remove the {org} organization's override for pre-receive hook {pre_receive_hook_id}.
Reset hook {pre_receive_hook_id} in {org} back to the inherited enforcement.
GET
/repos/{owner}/{repo}/pre-receive-hooks
List pre-receive hooks for a repository · GitHub List Pre-receive Hooks for a Repository
#
Ask an LLM
“Which pre-receive hooks will run on pushes to my repository?”
“What hooks am I allowed to enable at the repository level?”
Tell an agent
Show every pre-receive hook that applies to pushes into repository {owner}/{repo}.
Show repo-level pre-receive hooks on {owner}/{repo} in {direction} order.
GET
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}
Get a pre-receive hook for a repository · GitHub Get a Pre-receive Hook for a Repository
#
Ask an LLM
“Is a given pre-receive hook enforced on my repository or only testing?”
“How is a hook configured for one specific repo?”
Tell an agent
Get pre-receive hook {pre_receive_hook_id} for {owner}/{repo}.
Show the repo-level enforcement of hook {pre_receive_hook_id} on {owner}/{repo}.
PATCH
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}
Set a pre-receive hook's enforcement for a repo · GitHub Update Pre-receive Hook Enforcement for a Repository
#
Ask an LLM
“How do I disable a pre-receive hook on just one repository?”
“Can I enable a hook on my repo when the org allows it?”
Tell an agent
Set enforcement of hook {pre_receive_hook_id} on {owner}/{repo} to {enforcement}.
Turn pre-receive hook {pre_receive_hook_id} to {enforcement} for repository {owner}/{repo} only.
DELETE
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}
Clear a repo's pre-receive hook override · GitHub Remove Pre-receive Hook Enforcement for a Repository
#
Ask an LLM
“How do I make a repository inherit the org or global enforcement for a hook again?”
“Can I remove a repo-level override on a pre-receive hook?”
Tell an agent destructive · confirm first
Remove the override for pre-receive hook {pre_receive_hook_id} on {owner}/{repo}.
Reset hook {pre_receive_hook_id} on repository {owner}/{repo} to inherited enforcement.
POST
/scim/v2/Groups
Provision a SCIM group for the enterprise · GitHub Provision a SCIM Enterprise Group
#
Ask an LLM
“How do I create an enterprise group through SCIM from our identity provider?”
“Can members be added at the same time a SCIM group is provisioned?”
Tell an agent
Provision a SCIM group {displayName} with external ID {externalId}, schemas {schemas} and members {members}.
Create enterprise SCIM group {displayName} ({externalId}) using schemas {schemas} with no members yet: {members}.
GET
/scim/v2/Groups/{scim_group_id}
Get a provisioned SCIM group · GitHub Get SCIM Provisioning Information for an Enterprise Group
#
Ask an LLM
“What members and external ID does a SCIM-provisioned enterprise group have?”
“Can I fetch a SCIM group without its member list?”
Tell an agent
Get SCIM group {scim_group_id}.
Show SCIM group {scim_group_id} excluding {excludedAttributes}.
PUT
/scim/v2/Groups/{scim_group_id}
Replace a provisioned SCIM group · GitHub Set SCIM Information for a Provisioned Enterprise Group
#
Ask an LLM
“How do I fully replace a SCIM group's name and membership?”
“Do I need to send every group attribute when overwriting a SCIM group?”
Tell an agent
Replace SCIM group {scim_group_id} with name {displayName}, external ID {externalId}, schemas {schemas} and members {members}.
Overwrite all of group {scim_group_id}: {displayName}, {externalId}, schemas {schemas}, member list {members}.
PATCH
/scim/v2/Groups/{scim_group_id}
Patch attributes of a SCIM group · GitHub Update an Attribute for a SCIM Enterprise Group
#
Ask an LLM
“How do I add or remove one member from a SCIM group without replacing it?”
“Can I change just a SCIM group's display name with a patch operation?”
Tell an agent
Apply the operations {Operations} to SCIM group {scim_group_id} using schemas {schemas}.
Patch a single attribute on group {scim_group_id} with {Operations} ({schemas}).
DELETE
/scim/v2/Groups/{scim_group_id}
Delete a SCIM group · GitHub Delete a SCIM Group from an Enterprise
#
Ask an LLM
“How do I remove a SCIM-provisioned group from the enterprise?”
“Can I deprovision a group that was removed from our identity provider?”
Tell an agent destructive · confirm first
Delete SCIM group {scim_group_id}.
Deprovision enterprise group {scim_group_id}.
GET
/scim/v2/Users
List SCIM-provisioned enterprise users · GitHub List SCIM Provisioned Identities for an Enterprise
#
Ask an LLM
“Which users have been provisioned into the enterprise through SCIM?”
“Can I filter provisioned identities by userName or externalId?”
Tell an agent
List the SCIM-provisioned identities for the enterprise.
Find provisioned users matching the filter {filter}.
POST
/scim/v2/Users
Provision a SCIM user for the enterprise · GitHub Provision a SCIM Enterprise User
#
Ask an LLM
“How do I create an external identity for a new enterprise user through SCIM?”
“Does SCIM provisioning authenticate the user or only create the account?”
Tell an agent
Provision SCIM user {userName} named {displayName} with emails {emails}, external ID {externalId}, active {active}, schemas {schemas}.
Create enterprise identity {userName} ({externalId}) for {displayName}, emails {emails}, roles {roles}, active {active}, schemas {schemas}.
GET
/scim/v2/Users/{scim_user_id}
Get a provisioned SCIM user · GitHub Get SCIM Provisioning Information for an Enterprise User
#
Ask an LLM
“What SCIM identity data do we hold for a specific enterprise user?”
“Is a provisioned user still marked active?”
Tell an agent
Get SCIM user {scim_user_id}.
Show the provisioned identity for enterprise user {scim_user_id}.
PUT
/scim/v2/Users/{scim_user_id}
Replace a provisioned SCIM user · GitHub Set SCIM Information for a Provisioned Enterprise User
#
Ask an LLM
“How do I overwrite all of a SCIM user's attributes at once?”
“What happens to attributes I leave out when replacing a provisioned user?”
Tell an agent
Replace SCIM user {scim_user_id} with {userName}, {displayName}, emails {emails}, ID {externalId}, active {active}, schemas {schemas}.
Overwrite identity {scim_user_id}: {userName}, {displayName}, {emails}, {externalId}, active {active}, schemas {schemas}.
PATCH
/scim/v2/Users/{scim_user_id}
Patch attributes of a SCIM user · GitHub Update an Attribute for a SCIM Enterprise User
#
Ask an LLM
“How do I deactivate a SCIM user by patching just the active attribute?”
“Can I change one field on a provisioned user without resending everything?”
Tell an agent
Apply the operations {Operations} to SCIM user {scim_user_id} using schemas {schemas}.
Patch a single attribute on identity {scim_user_id} with {Operations} ({schemas}).
DELETE
/scim/v2/Users/{scim_user_id}
Delete a SCIM user from the enterprise · GitHub Delete a SCIM User from an Enterprise
#
Ask an LLM
“What happens to a user's data when I delete their SCIM identity from the enterprise?”
“How do I permanently deprovision a SCIM user?”
Tell an agent destructive · confirm first
Delete SCIM user {scim_user_id} from the enterprise.
Permanently deprovision SCIM identity {scim_user_id} and remove their data.
GET
/setup/api/configcheck
Check the configuration run status · GitHub Get the Configuration Status
#
Ask an LLM
“Has the most recent configuration run on the appliance finished?”
“What does each configuration process status mean?”
Tell an agent
Check the status of the latest configuration process.
Tell me whether the settings configuration run is still in progress.
Ask an LLM
“How do I apply updated appliance settings so they take effect?”
“Can I kick off a configuration process any time through the API?”
Tell an agent
Start a configuration process on the instance.
Run configuration now so my updated settings take effect.
Ask an LLM
“Is our GitHub Enterprise instance currently in maintenance mode?”
“When is maintenance mode scheduled to start?”
Tell an agent
Get the instance's maintenance status.
Check whether maintenance mode is on or scheduled.
POST
/setup/api/maintenance
Turn maintenance mode on or off · GitHub Enable or Disable Maintenance Mode
#
Ask an LLM
“How do I put the enterprise instance into maintenance mode before an upgrade?”
“Can I schedule maintenance mode for later instead of starting it now?”
Tell an agent
Set maintenance mode using {maintenance}.
Enable or schedule maintenance on the instance with the settings {maintenance}.
Ask an LLM
“What management console settings is our instance currently running with?”
“Can I read the appliance settings, including the admin password?”
Tell an agent
Get the instance settings.
Show the current appliance configuration settings.
Ask an LLM
“How do I change management console settings through the API?”
“Do new appliance settings take effect without a configuration run?”
Tell an agent
Apply the settings {settings} to the instance.
Update the appliance configuration with {settings}.
GET
/setup/api/settings/authorized-keys
List administrative SSH keys · GitHub Get All Authorized SSH Keys
#
Ask an LLM
“Which SSH keys can reach the administrative shell on our appliance?”
“What authorized keys are set in the management console?”
Tell an agent
List all authorized SSH keys for the admin shell.
Show the management console's authorized keys.
POST
/setup/api/settings/authorized-keys
Add an administrative SSH key · GitHub Add an Authorized SSH Key
#
Ask an LLM
“How do I give a new admin SSH access to the appliance's administrative shell?”
“Can I add an authorized key without logging into the management console?”
Tell an agent
Add the authorized SSH key {authorized_key}.
Grant admin shell access to the public key {authorized_key}.
DELETE
/setup/api/settings/authorized-keys
Remove an administrative SSH key · GitHub Remove an Authorized SSH Key
#
Ask an LLM
“How do I revoke someone's SSH access to the administrative shell?”
“Can I delete an authorized key from the management console by its value?”
Tell an agent destructive · confirm first
Remove the authorized SSH key {authorized_key}.
Revoke admin shell access for the public key {authorized_key}.
Ask an LLM
“How do I upload a license when booting a new enterprise server for the first time?”
“Can I set the management console password along with the initial license?”
Tell an agent
Upload the initial license {license}.
Install license {license} on this new instance and set the console password to {password}.
Ask an LLM
“How do I upload a renewed license to an already-running instance?”
“Does upgrading the license trigger a configuration run?”
Tell an agent
Upgrade the license with {license}.
Replace the running instance's license with the renewed file {license}.
PUT
/users/{username}/site_admin
Make a user a site administrator · GitHub Promote a User to Be a Site Administrator
#
Ask an LLM
“How do I grant a user site admin rights on the instance?”
“Can I promote someone to site administrator through the API?”
Tell an agent
Promote {username} to site administrator.
Give {username} site admin privileges.
DELETE
/users/{username}/site_admin
Demote a site administrator · GitHub Demote a Site Administrator
#
Ask an LLM
“How do I take site admin rights away from a user?”
“Can I demote my own site administrator account?”
Tell an agent destructive · confirm first
Demote {username} from site administrator.
Remove site admin privileges from {username}.
Ask an LLM
“How do I block a user from signing in without deleting their account?”
“Can I record a reason when I suspend someone?”
Tell an agent destructive · confirm first
Suspend user {username}.
Suspend {username} with the reason {reason}.
Ask an LLM
“How do I restore access for a user I previously suspended?”
“Can I note why I'm reinstating a suspended account?”
Tell an agent destructive · confirm first
Unsuspend user {username}.
Reinstate suspended account {username} with the reason {reason}.
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-enterprise-admin-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-enterprise-settings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-ldap-mapping-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-audit-log-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-simple-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-authorization-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-enterprise-security-analysis-settings-schema.json