GitHub
Home
Link
Multiple Menus
Multiple Menus
  • Link1
  • Link2
Home
Link
Multiple Menus
Multiple Menus
  • Link1
  • Link2
  1. enterprise-admin
  • About the REST API
  • meta
    • GitHub API Root
    • Get GitHub Enterprise Server meta information
    • Get Octocat
    • Get the Zen of GitHub
  • enterprise-admin
    • List global webhooks
      GET
    • Create a global webhook
      POST
    • Get a global webhook
      GET
    • Update a global webhook
      PATCH
    • Delete a global webhook
      DELETE
    • Ping a global webhook
      POST
    • List public keys
      GET
    • Delete a public key
      DELETE
    • Update LDAP mapping for a team
      PATCH
    • Sync LDAP mapping for a team
      POST
    • Update LDAP mapping for a user
      PATCH
    • Sync LDAP mapping for a user
      POST
    • Create an organization
      POST
    • Update an organization name
      PATCH
    • List pre-receive environments
      GET
    • Create a pre-receive environment
      POST
    • Get a pre-receive environment
      GET
    • Update a pre-receive environment
      PATCH
    • Delete a pre-receive environment
      DELETE
    • Start a pre-receive environment download
      POST
    • Get the download status for a pre-receive environment
      GET
    • List pre-receive hooks
      GET
    • Create a pre-receive hook
      POST
    • Get a pre-receive hook
      GET
    • Update a pre-receive hook
      PATCH
    • Delete a pre-receive hook
      DELETE
    • List personal access tokens
      GET
    • Delete a personal access token
      DELETE
    • Create a user
      POST
    • Update the username for a user
      PATCH
    • Delete a user
      DELETE
    • Create an impersonation OAuth token
      POST
    • Delete an impersonation OAuth token
      DELETE
    • Get the global announcement banner
      GET
    • Set the global announcement banner
      PATCH
    • Remove the global announcement banner
      DELETE
    • Get license information
      GET
    • Get all statistics
      GET
    • Get comment statistics
      GET
    • Get gist statistics
      GET
    • Get hooks statistics
      GET
    • Get issue statistics
      GET
    • Get milestone statistics
      GET
    • Get organization statistics
      GET
    • Get pages statistics
      GET
    • Get pull request statistics
      GET
    • Get repository statistics
      GET
    • Get users statistics
      GET
    • Get GitHub Actions permissions for an enterprise
      GET
    • Set GitHub Actions permissions for an enterprise
      PUT
    • List selected organizations enabled for GitHub Actions in an enterprise
      GET
    • Set selected organizations enabled for GitHub Actions in an enterprise
      PUT
    • Enable a selected organization for GitHub Actions in an enterprise
      PUT
    • Disable a selected organization for GitHub Actions in an enterprise
      DELETE
    • Get allowed actions for an enterprise
      GET
    • Set allowed actions for an enterprise
      PUT
    • List self-hosted runner groups for an enterprise
      GET
    • Create a self-hosted runner group for an enterprise
      POST
    • Get a self-hosted runner group for an enterprise
      GET
    • Update a self-hosted runner group for an enterprise
      PATCH
    • Delete a self-hosted runner group from an enterprise
      DELETE
    • List organization access to a self-hosted runner group in an enterprise
      GET
    • Set organization access for a self-hosted runner group in an enterprise
      PUT
    • Add organization access to a self-hosted runner group in an enterprise
      PUT
    • Remove organization access to a self-hosted runner group in an enterprise
      DELETE
    • List self-hosted runners in a group for an enterprise
      GET
    • Set self-hosted runners in a group for an enterprise
      PUT
    • Add a self-hosted runner to a group for an enterprise
      PUT
    • Remove a self-hosted runner from a group for an enterprise
      DELETE
    • List self-hosted runners for an enterprise
      GET
    • List runner applications for an enterprise
      GET
    • Create a registration token for an enterprise
      POST
    • Create a remove token for an enterprise
      POST
    • Get a self-hosted runner for an enterprise
      GET
    • Delete a self-hosted runner from an enterprise
      DELETE
    • List labels for a self-hosted runner for an enterprise
      GET
    • Add custom labels to a self-hosted runner for an enterprise
      POST
    • Set custom labels for a self-hosted runner for an enterprise
      PUT
    • Remove all custom labels from a self-hosted runner for an enterprise
      DELETE
    • Remove a custom label from a self-hosted runner for an enterprise
      DELETE
    • Get the audit log for an enterprise
      GET
    • Get code security and analysis features for an enterprise
      GET
    • Update code security and analysis features for an enterprise
      PATCH
    • Enable or disable a security feature
      POST
    • Get GHES node metadata for all nodes
      GET
    • Get the status of services running on all replica nodes
      GET
    • Get all GHES release versions for all nodes
      GET
    • List pre-receive hooks for an organization
      GET
    • Get a pre-receive hook for an organization
      GET
    • Update pre-receive hook enforcement for an organization
      PATCH
    • Remove pre-receive hook enforcement for an organization
      DELETE
    • List pre-receive hooks for a repository
      GET
    • Get a pre-receive hook for a repository
      GET
    • Update pre-receive hook enforcement for a repository
      PATCH
    • Remove pre-receive hook enforcement for a repository
      DELETE
    • List provisioned SCIM groups for an enterprise
      GET
    • Provision a SCIM enterprise group
      POST
    • Get SCIM provisioning information for an enterprise group
      GET
    • Set SCIM information for a provisioned enterprise group
      PUT
    • Update an attribute for a SCIM enterprise group
      PATCH
    • Delete a SCIM group from an enterprise
      DELETE
    • List SCIM provisioned identities for an enterprise
      GET
    • Provision a SCIM enterprise user
      POST
    • Get SCIM provisioning information for an enterprise user
      GET
    • Set SCIM information for a provisioned enterprise user
      PUT
    • Update an attribute for a SCIM enterprise user
      PATCH
    • Delete a SCIM user from an enterprise
      DELETE
    • Get the configuration status
      GET
    • Start a configuration process
      POST
    • Get the maintenance status
      GET
    • Enable or disable maintenance mode
      POST
    • Get settings
      GET
    • Set settings
      PUT
    • Get all authorized SSH keys
      GET
    • Add an authorized SSH key
      POST
    • Remove an authorized SSH key
      DELETE
    • Create a GitHub license
      POST
    • Upgrade a license
      POST
    • Promote a user to be a site administrator
      PUT
    • Demote a site administrator
      DELETE
    • Suspend a user
      PUT
    • Unsuspend a user
      DELETE
  • apps
    • Get the authenticated app
    • Create a GitHub App from a manifest
    • Get a webhook configuration for an app
    • Update a webhook configuration for an app
    • List deliveries for an app webhook
    • Get a delivery for an app webhook
    • Redeliver a delivery for an app webhook
    • List installation requests for the authenticated app
    • List installations for the authenticated app
    • Get an installation for the authenticated app
    • Delete an installation for the authenticated app
    • Create an installation access token for an app
    • Suspend an app installation
    • Unsuspend an app installation
    • Delete an app authorization
    • Check a token
    • Reset a token
    • Delete an app token
    • Create a scoped access token
    • Get an app
    • List repositories accessible to the app installation
    • Revoke an installation access token
    • Get an organization installation for the authenticated app
    • Get a repository installation for the authenticated app
    • List app installations accessible to the user access token
    • List repositories accessible to the user access token
    • Add a repository to an app installation
    • Remove a repository from an app installation
    • Get a user installation for the authenticated app
  • oauth-authorizations
    • List your grants
    • Get a single grant
    • Delete a grant
    • List your authorizations
    • Create a new authorization
    • Get-or-create an authorization for a specific app
    • Get-or-create an authorization for a specific app and fingerprint
    • Get a single authorization
    • Update an existing authorization
    • Delete an authorization
  • codes-of-conduct
    • Get all codes of conduct
    • Get a code of conduct
  • emojis
    • Get emojis
  • actions
    • Get GitHub Actions cache usage for an enterprise
    • Get GitHub Actions cache usage policy for an enterprise
    • Set GitHub Actions cache usage policy for an enterprise
    • Get default workflow permissions for an enterprise
    • Set default workflow permissions for an enterprise
    • Get GitHub Actions cache usage for an organization
    • List repositories with GitHub Actions cache usage for an organization
    • Get GitHub Actions permissions for an organization
    • Set GitHub Actions permissions for an organization
    • List selected repositories enabled for GitHub Actions in an organization
    • Set selected repositories enabled for GitHub Actions in an organization
    • Enable a selected repository for GitHub Actions in an organization
    • Disable a selected repository for GitHub Actions in an organization
    • Get allowed actions for an organization
    • Set allowed actions for an organization
    • Get default workflow permissions for an organization
    • Set default workflow permissions for an organization
    • List self-hosted runner groups for an organization
    • Create a self-hosted runner group for an organization
    • Get a self-hosted runner group for an organization
    • Update a self-hosted runner group for an organization
    • Delete a self-hosted runner group from an organization
    • List repository access to a self-hosted runner group in an organization
    • Set repository access for a self-hosted runner group in an organization
    • Add repository access to a self-hosted runner group in an organization
    • Remove repository access to a self-hosted runner group in an organization
    • List self-hosted runners in a group for an organization
    • Set self-hosted runners in a group for an organization
    • Add a self-hosted runner to a group for an organization
    • Remove a self-hosted runner from a group for an organization
    • List self-hosted runners for an organization
    • List runner applications for an organization
    • Create a registration token for an organization
    • Create a remove token for an organization
    • Get a self-hosted runner for an organization
    • Delete a self-hosted runner from an organization
    • List labels for a self-hosted runner for an organization
    • Add custom labels to a self-hosted runner for an organization
    • Set custom labels for a self-hosted runner for an organization
    • Remove all custom labels from a self-hosted runner for an organization
    • Remove a custom label from a self-hosted runner for an organization
    • List organization secrets
    • Get an organization public key
    • Get an organization secret
    • Create or update an organization secret
    • Delete an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Add selected repository to an organization secret
    • Remove selected repository from an organization secret
    • List organization variables
    • Create an organization variable
    • Get an organization variable
    • Update an organization variable
    • Delete an organization variable
    • List selected repositories for an organization variable
    • Set selected repositories for an organization variable
    • Add selected repository to an organization variable
    • Remove selected repository from an organization variable
    • List artifacts for a repository
    • Get an artifact
    • Delete an artifact
    • Download an artifact
    • Get GitHub Actions cache usage for a repository
    • Get GitHub Actions cache usage policy for a repository
    • Set GitHub Actions cache usage policy for a repository
    • List GitHub Actions caches for a repository
    • Delete GitHub Actions caches for a repository (using a cache key)
    • Delete a GitHub Actions cache for a repository (using a cache ID)
    • Get a job for a workflow run
    • Download job logs for a workflow run
    • Re-run a job from a workflow run
    • Get the customization template for an OIDC subject claim for a repository
    • Set the customization template for an OIDC subject claim for a repository
    • List repository organization secrets
    • List repository organization variables
    • Get GitHub Actions permissions for a repository
    • Set GitHub Actions permissions for a repository
    • Get the level of access for workflows outside of the repository
    • Set the level of access for workflows outside of the repository
    • Get allowed actions for a repository
    • Set allowed actions for a repository
    • Get default workflow permissions for a repository
    • Set default workflow permissions for a repository
    • List self-hosted runners for a repository
    • List runner applications for a repository
    • Create a registration token for a repository
    • Create a remove token for a repository
    • Get a self-hosted runner for a repository
    • Delete a self-hosted runner from a repository
    • List labels for a self-hosted runner for a repository
    • Add custom labels to a self-hosted runner for a repository
    • Set custom labels for a self-hosted runner for a repository
    • Remove all custom labels from a self-hosted runner for a repository
    • Remove a custom label from a self-hosted runner for a repository
    • List workflow runs for a repository
    • Get a workflow run
    • Delete a workflow run
    • Get the review history for a workflow run
    • List workflow run artifacts
    • Get a workflow run attempt
    • List jobs for a workflow run attempt
    • Download workflow run attempt logs
    • Cancel a workflow run
    • List jobs for a workflow run
    • Download workflow run logs
    • Delete workflow run logs
    • Get pending deployments for a workflow run
    • Review pending deployments for a workflow run
    • Re-run a workflow
    • Re-run failed jobs from a workflow run
    • List repository secrets
    • Get a repository public key
    • Get a repository secret
    • Create or update a repository secret
    • Delete a repository secret
    • List repository variables
    • Create a repository variable
    • Get a repository variable
    • Update a repository variable
    • Delete a repository variable
    • List repository workflows
    • Get a workflow
    • Disable a workflow
    • Create a workflow dispatch event
    • Enable a workflow
    • List workflow runs for a workflow
    • List environment secrets
    • Get an environment public key
    • Get an environment secret
    • Create or update an environment secret
    • Delete an environment secret
    • List environment variables
    • Create an environment variable
    • Get an environment variable
    • Update an environment variable
    • Delete an environment variable
  • code-scanning
    • List code scanning alerts for an enterprise
    • List code scanning alerts for an organization
    • List code scanning alerts for a repository
    • Get a code scanning alert
    • Update a code scanning alert
    • List instances of a code scanning alert
    • List code scanning analyses for a repository
    • Get a code scanning analysis for a repository
    • Delete a code scanning analysis from a repository
    • Get a code scanning default setup configuration
    • Update a code scanning default setup configuration
    • Upload an analysis as SARIF data
    • Get information about a SARIF upload
  • dependabot
    • List Dependabot alerts for an enterprise
    • List Dependabot alerts for an organization
    • List organization secrets
    • Get an organization public key
    • Get an organization secret
    • Create or update an organization secret
    • Delete an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Add selected repository to an organization secret
    • Remove selected repository from an organization secret
    • List Dependabot alerts for a repository
    • Get a Dependabot alert
    • Update a Dependabot alert
    • List repository secrets
    • Get a repository public key
    • Get a repository secret
    • Create or update a repository secret
    • Delete a repository secret
  • secret-scanning
    • List secret scanning alerts for an enterprise
    • List secret scanning alerts for an organization
    • List secret scanning alerts for a repository
    • Get a secret scanning alert
    • Update a secret scanning alert
    • List locations for a secret scanning alert
  • billing
    • Get GitHub Advanced Security active committers for an enterprise
    • Get GitHub Advanced Security active committers for an organization
  • activity
    • List public events
    • Get feeds
    • List public events for a network of repositories
    • List notifications for the authenticated user
    • Mark notifications as read
    • Get a thread
    • Mark a thread as read
    • Get a thread subscription for the authenticated user
    • Set a thread subscription
    • Delete a thread subscription
    • List public organization events
    • List repository events
    • List repository notifications for the authenticated user
    • Mark repository notifications as read
    • List stargazers
    • List watchers
    • Get a repository subscription
    • Set a repository subscription
    • Delete a repository subscription
    • List repositories starred by the authenticated user
    • Check if a repository is starred by the authenticated user
    • Star a repository for the authenticated user
    • Unstar a repository for the authenticated user
    • List repositories watched by the authenticated user
    • List events for the authenticated user
    • List organization events for the authenticated user
    • List public events for a user
    • List events received by the authenticated user
    • List public events received by a user
    • List repositories starred by a user
    • List repositories watched by a user
  • gists
    • List gists for the authenticated user
    • Create a gist
    • List public gists
    • List starred gists
    • Get a gist
    • Update a gist
    • Delete a gist
    • List gist comments
    • Create a gist comment
    • Get a gist comment
    • Update a gist comment
    • Delete a gist comment
    • List gist commits
    • List gist forks
    • Fork a gist
    • Check if a gist is starred
    • Star a gist
    • Unstar a gist
    • Get a gist revision
    • List gists for a user
  • gitignore
    • Get all gitignore templates
    • Get a gitignore template
  • issues
    • List issues assigned to the authenticated user
    • List organization issues assigned to the authenticated user
    • List assignees
    • Check if a user can be assigned
    • List repository issues
    • Create an issue
    • List issue comments for a repository
    • Get an issue comment
    • Update an issue comment
    • Delete an issue comment
    • List issue events for a repository
    • Get an issue event
    • Get an issue
    • Update an issue
    • Add assignees to an issue
    • Remove assignees from an issue
    • Check if a user can be assigned to a issue
    • List issue comments
    • Create an issue comment
    • List issue events
    • List labels for an issue
    • Add labels to an issue
    • Set labels for an issue
    • Remove all labels from an issue
    • Remove a label from an issue
    • Lock an issue
    • Unlock an issue
    • List timeline events for an issue
    • List labels for a repository
    • Create a label
    • Get a label
    • Update a label
    • Delete a label
    • List milestones
    • Create a milestone
    • Get a milestone
    • Update a milestone
    • Delete a milestone
    • List labels for issues in a milestone
    • List user account issues assigned to the authenticated user
  • licenses
    • Get all commonly used licenses
    • Get a license
    • Get the license for a repository
  • markdown
    • Render a Markdown document
    • Render a Markdown document in raw mode
  • orgs
    • List organizations
    • Deprecated - List custom repository roles in an organization
    • Get an organization
    • Update an organization
    • Delete an organization
    • Get announcement banner for organization
    • Set announcement banner for organization
    • Remove announcement banner from organization
    • Get the audit log for an organization
    • List custom repository roles in an organization
    • Create a custom repository role
    • Get a custom repository role
    • Update a custom repository role
    • Delete a custom repository role
    • List organization webhooks
    • Create an organization webhook
    • Get an organization webhook
    • Update an organization webhook
    • Delete an organization webhook
    • Get a webhook configuration for an organization
    • Update a webhook configuration for an organization
    • List deliveries for an organization webhook
    • Get a webhook delivery for an organization webhook
    • Redeliver a delivery for an organization webhook
    • Ping an organization webhook
    • List app installations for an organization
    • List organization members
    • Check organization membership for a user
    • Remove an organization member
    • Get organization membership for a user
    • Set organization membership for a user
    • Remove organization membership for a user
    • List outside collaborators for an organization
    • Convert an organization member to outside collaborator
    • Remove outside collaborator from an organization
    • List public organization members
    • Check public organization membership for a user
    • Set public organization membership for the authenticated user
    • Remove public organization membership for the authenticated user
    • List repository fine-grained permissions for an organization
    • List security manager teams
    • Add a security manager team
    • Remove a security manager team
    • Enable or disable a security feature for an organization
    • List organization memberships for the authenticated user
    • Get an organization membership for the authenticated user
    • Update an organization membership for the authenticated user
    • List organizations for the authenticated user
    • List organizations for a user
  • oidc
    • Get the customization template for an OIDC subject claim for an organization
    • Set the customization template for an OIDC subject claim for an organization
  • packages
    • Get list of conflicting packages during Docker migration for organization
    • List packages for an organization
    • Get a package for an organization
    • Delete a package for an organization
    • Restore a package for an organization
    • List package versions for a package owned by an organization
    • Get a package version for an organization
    • Delete package version for an organization
    • Restore package version for an organization
    • Get list of conflicting packages during Docker migration for authenticated-user
    • List packages for the authenticated user's namespace
    • Get a package for the authenticated user
    • Delete a package for the authenticated user
    • Restore a package for the authenticated user
    • List package versions for a package owned by the authenticated user
    • Get a package version for the authenticated user
    • Delete a package version for the authenticated user
    • Restore a package version for the authenticated user
    • Get list of conflicting packages during Docker migration for user
    • List packages for a user
    • Get a package for a user
    • Delete a package for a user
    • Restore a package for a user
    • List package versions for a package owned by a user
    • Get a package version for a user
    • Delete package version for a user
    • Restore package version for a user
  • teams
    • Get an external group
    • List external groups in an organization
    • List teams
    • Create a team
    • Get a team by name
    • Update a team
    • Delete a team
    • List discussions
    • Create a discussion
    • Get a discussion
    • Update a discussion
    • Delete a discussion
    • List discussion comments
    • Create a discussion comment
    • Get a discussion comment
    • Update a discussion comment
    • Delete a discussion comment
    • List a connection between an external group and a team
    • Update the connection between an external group and a team
    • Remove the connection between an external group and a team
    • List team members
    • Get team membership for a user
    • Add or update team membership for a user
    • Remove team membership for a user
    • List team projects
    • Check team permissions for a project
    • Add or update team project permissions
    • Remove a project from a team
    • List team repositories
    • Check team permissions for a repository
    • Add or update team repository permissions
    • Remove a repository from a team
    • List child teams
    • Get a team (Legacy)
    • Update a team (Legacy)
    • Delete a team (Legacy)
    • List discussions (Legacy)
    • Create a discussion (Legacy)
    • Get a discussion (Legacy)
    • Update a discussion (Legacy)
    • Delete a discussion (Legacy)
    • List discussion comments (Legacy)
    • Create a discussion comment (Legacy)
    • Get a discussion comment (Legacy)
    • Update a discussion comment (Legacy)
    • Delete a discussion comment (Legacy)
    • List team members (Legacy)
    • Get team member (Legacy)
    • Add team member (Legacy)
    • Remove team member (Legacy)
    • Get team membership for a user (Legacy)
    • Add or update team membership for a user (Legacy)
    • Remove team membership for a user (Legacy)
    • List team projects (Legacy)
    • Check team permissions for a project (Legacy)
    • Add or update team project permissions (Legacy)
    • Remove a project from a team (Legacy)
    • List team repositories (Legacy)
    • Check team permissions for a repository (Legacy)
    • Add or update team repository permissions (Legacy)
    • Remove a repository from a team (Legacy)
    • List child teams (Legacy)
    • List teams for the authenticated user
  • migrations
    • List organization migrations
    • Start an organization migration
    • Get an organization migration status
    • Download an organization migration archive
    • Delete an organization migration archive
    • Unlock an organization repository
    • List repositories in an organization migration
    • List user migrations
    • Start a user migration
    • Download a user migration archive
    • List repositories for a user migration
  • projects
    • List organization projects
    • Create an organization project
    • Get a project card
    • Update an existing project card
    • Delete a project card
    • Move a project card
    • Get a project column
    • Update an existing project column
    • Delete a project column
    • List project cards
    • Create a project card
    • Move a project column
    • Get a project
    • Update a project
    • Delete a project
    • List project collaborators
    • Add project collaborator
    • Remove user as a collaborator
    • Get project permission for a user
    • List project columns
    • Create a project column
    • List repository projects
    • Create a repository project
    • Create a user project
    • List user projects
  • repos
    • List organization repositories
    • Create an organization repository
    • Get a repository
    • Update a repository
    • Delete a repository
    • Get all autolinks of a repository
    • Create an autolink reference for a repository
    • Get an autolink reference of a repository
    • Delete an autolink reference from a repository
    • List branches
    • Get a branch
    • Get branch protection
    • Update branch protection
    • Delete branch protection
    • Get admin branch protection
    • Set admin branch protection
    • Delete admin branch protection
    • Get pull request review protection
    • Update pull request review protection
    • Delete pull request review protection
    • Get commit signature protection
    • Create commit signature protection
    • Delete commit signature protection
    • Get status checks protection
    • Update status check protection
    • Remove status check protection
    • Get all status check contexts
    • Add status check contexts
    • Set status check contexts
    • Remove status check contexts
    • Get access restrictions
    • Delete access restrictions
    • Get apps with access to the protected branch
    • Add app access restrictions
    • Set app access restrictions
    • Remove app access restrictions
    • Get teams with access to the protected branch
    • Add team access restrictions
    • Set team access restrictions
    • Remove team access restrictions
    • Get users with access to the protected branch
    • Add user access restrictions
    • Set user access restrictions
    • Remove user access restrictions
    • Rename a branch
    • List CODEOWNERS errors
    • List repository collaborators
    • Check if a user is a repository collaborator
    • Add a repository collaborator
    • Remove a repository collaborator
    • Get repository permissions for a user
    • List commit comments for a repository
    • Get a commit comment
    • Update a commit comment
    • Delete a commit comment
    • List commits
    • List branches for HEAD commit
    • List commit comments
    • Create a commit comment
    • List pull requests associated with a commit
    • Get a commit
    • Get the combined status for a specific reference
    • List commit statuses for a reference
    • Compare two commits
    • Get repository content
    • Create or update file contents
    • Delete a file
    • List repository contributors
    • List deployments
    • Create a deployment
    • Get a deployment
    • Delete a deployment
    • List deployment statuses
    • Create a deployment status
    • Get a deployment status
    • Create a repository dispatch event
    • List environments
    • Get an environment
    • Create or update an environment
    • Delete an environment
    • List deployment branch policies
    • Create a deployment branch policy
    • Get a deployment branch policy
    • Update a deployment branch policy
    • Delete a deployment branch policy
    • List forks
    • Create a fork
    • List repository webhooks
    • Create a repository webhook
    • Get a repository webhook
    • Update a repository webhook
    • Delete a repository webhook
    • Get a webhook configuration for a repository
    • Update a webhook configuration for a repository
    • List deliveries for a repository webhook
    • Get a delivery for a repository webhook
    • Redeliver a delivery for a repository webhook
    • Ping a repository webhook
    • Test the push repository webhook
    • List repository invitations
    • Update a repository invitation
    • Delete a repository invitation
    • List deploy keys
    • Create a deploy key
    • Get a deploy key
    • Delete a deploy key
    • List repository languages
    • Enable Git LFS for a repository
    • Disable Git LFS for a repository
    • Sync a fork branch with the upstream repository
    • Merge a branch
    • Get a GitHub Enterprise Server Pages site
    • Create a GitHub Enterprise Server Pages site
    • Update information about a GitHub Enterprise Server Pages site
    • Delete a GitHub Enterprise Server Pages site
    • List GitHub Enterprise Server Pages builds
    • Request a GitHub Enterprise Server Pages build
    • Get latest Pages build
    • Get GitHub Enterprise Server Pages build
    • Create a GitHub Pages deployment
    • Get a repository README
    • Get a repository README for a directory
    • List releases
    • Create a release
    • Get a release asset
    • Update a release asset
    • Delete a release asset
    • Generate release notes content for a release
    • Get the latest release
    • Get a release by tag name
    • Get a release
    • Update a release
    • Delete a release
    • List release assets
    • Upload a release asset
    • List repository cache replication status
    • Get the weekly commit activity
    • Get the last year of commit activity
    • Get all contributor commit activity
    • Get the weekly commit count
    • Get the hourly commit count for each day
    • Create a commit status
    • List repository tags
    • Deprecated - List tag protection states for a repository
    • Deprecated - Create a tag protection state for a repository
    • Deprecated - Delete a tag protection state for a repository
    • Download a repository archive (tar)
    • List repository teams
    • Get all repository topics
    • Replace all repository topics
    • Transfer a repository
    • Check if vulnerability alerts are enabled for a repository
    • Enable vulnerability alerts
    • Disable vulnerability alerts
    • Download a repository archive (zip)
    • Create a repository using a template
    • List public repositories
    • List repositories for the authenticated user
    • Create a repository for the authenticated user
    • List repository invitations for the authenticated user
    • Accept a repository invitation
    • Decline a repository invitation
    • List repositories for a user
  • reactions
    • List reactions for a team discussion comment
    • Create reaction for a team discussion comment
    • Delete team discussion comment reaction
    • List reactions for a team discussion
    • Create reaction for a team discussion
    • Delete team discussion reaction
    • List reactions for a commit comment
    • Create reaction for a commit comment
    • Delete a commit comment reaction
    • List reactions for an issue comment
    • Create reaction for an issue comment
    • Delete an issue comment reaction
    • List reactions for an issue
    • Create reaction for an issue
    • Delete an issue reaction
    • List reactions for a pull request review comment
    • Create reaction for a pull request review comment
    • Delete a pull request comment reaction
    • List reactions for a release
    • Create reaction for a release
    • Delete a release reaction
    • List reactions for a team discussion comment (Legacy)
    • Create reaction for a team discussion comment (Legacy)
    • List reactions for a team discussion (Legacy)
    • Create reaction for a team discussion (Legacy)
  • rate-limit
    • Get rate limit status for the authenticated user
  • checks
    • Create a check run
    • Get a check run
    • Update a check run
    • List check run annotations
    • Rerequest a check run
    • Create a check suite
    • Update repository preferences for check suites
    • Get a check suite
    • List check runs in a check suite
    • Rerequest a check suite
    • List check runs for a Git reference
    • List check suites for a Git reference
  • dependency-graph
    • Get a diff of the dependencies between commits
    • Export a software bill of materials (SBOM) for a repository.
    • Create a snapshot of dependencies for a repository
  • git
    • Create a blob
    • Get a blob
    • Create a commit
    • Get a commit object
    • List matching references
    • Get a reference
    • Create a reference
    • Update a reference
    • Delete a reference
    • Create a tag object
    • Get a tag
    • Create a tree
    • Get a tree
  • pulls
    • List pull requests
    • Create a pull request
    • List review comments in a repository
    • Get a review comment for a pull request
    • Update a review comment for a pull request
    • Delete a review comment for a pull request
    • Get a pull request
    • Update a pull request
    • List review comments on a pull request
    • Create a review comment for a pull request
    • Create a reply for a review comment
    • List commits on a pull request
    • List pull requests files
    • Check if a pull request has been merged
    • Merge a pull request
    • Get all requested reviewers for a pull request
    • Request reviewers for a pull request
    • Remove requested reviewers from a pull request
    • List reviews for a pull request
    • Create a review for a pull request
    • Get a review for a pull request
    • Update a review for a pull request
    • Delete a pending review for a pull request
    • List comments for a pull request review
    • Dismiss a review for a pull request
    • Submit a review for a pull request
    • Update a pull request branch
  • search
    • Search code
    • Search commits
    • Search issues and pull requests
    • Search labels
    • Search repositories
    • Search topics
    • Search users
  • users
    • Get the authenticated user
    • Update the authenticated user
    • List email addresses for the authenticated user
    • Add an email address for the authenticated user
    • Delete an email address for the authenticated user
    • List followers of the authenticated user
    • List the people the authenticated user follows
    • Check if a person is followed by the authenticated user
    • Follow a user
    • Unfollow a user
    • List GPG keys for the authenticated user
    • Create a GPG key for the authenticated user
    • Get a GPG key for the authenticated user
    • Delete a GPG key for the authenticated user
    • List public SSH keys for the authenticated user
    • Create a public SSH key for the authenticated user
    • Get a public SSH key for the authenticated user
    • Delete a public SSH key for the authenticated user
    • List public email addresses for the authenticated user
    • List social accounts for the authenticated user
    • Add social accounts for the authenticated user
    • Delete social accounts for the authenticated user
    • List SSH signing keys for the authenticated user
    • Create a SSH signing key for the authenticated user
    • Get an SSH signing key for the authenticated user
    • Delete an SSH signing key for the authenticated user
    • Get a user using their ID
    • List users
    • Get a user
    • List followers of a user
    • List the people a user follows
    • Check if a user follows another user
    • List GPG keys for a user
    • Get contextual information for a user
    • List public keys for a user
    • List social accounts for a user
    • List SSH signing keys for a user
  • スキーマ
    • Schemas
      • root
      • global-hook
      • global-hook-2
      • public-key-full
      • ldap-mapping-team
      • Ldap Private User
      • Organization Simple
      • pre-receive-environment
      • pre-receive-environment-download-status
      • pre-receive-hook
      • Simple User
      • App Permissions
      • Simple User
      • Scoped Installation
      • Authorization
      • GitHub app
      • Basic Error
      • Validation Error Simple
      • webhook-config-url
      • webhook-config-content-type
      • webhook-config-secret
      • webhook-config-insecure-ssl
      • Webhook Configuration
      • Simple webhook delivery
      • Scim Error
      • Validation Error
      • Webhook delivery
      • Enterprise
      • Integration Installation Request
      • Installation
      • License Simple
      • Repository
      • Installation Token
      • Application Grant
      • Code Of Conduct
      • announcement-message
      • announcement-expiration
      • Enterprise Announcement
      • license-info
      • Repository Enterprise Stats
      • Hooks Enterprise Stats
      • Enterprise Pages Stats
      • Enterprise Organization Stats
      • Enterprise User Stats
      • Enterprise Pull Request Stats
      • Enterprise Issue Stats
      • Enterprise Milestone Stats
      • Enterprise Gist Stats
      • Enterprise Comment Stats
      • enterprise-overview
      • actions-cache-usage-org-enterprise
      • Actions cache usage policy for an enterprise
      • enabled-organizations
      • allowed-actions
      • selected-actions-url
      • actions-enterprise-permissions
      • selected-actions
      • actions-default-workflow-permissions
      • actions-can-approve-pull-request-reviews
      • actions-get-default-workflow-permissions
      • actions-set-default-workflow-permissions
      • runner-groups-enterprise
      • Self hosted runner label
      • Self hosted runners
      • Runner Application
      • Authentication Token
      • audit-log-event
      • code-scanning-analysis-tool-name
      • code-scanning-analysis-tool-guid
      • code-scanning-alert-state-query
      • alert-number
      • alert-created-at
      • alert-updated-at
      • alert-url
      • alert-html-url
      • alert-instances-url
      • code-scanning-alert-state
      • alert-fixed-at
      • alert-dismissed-at
      • code-scanning-alert-dismissed-reason
      • code-scanning-alert-dismissed-comment
      • code-scanning-alert-rule-summary
      • code-scanning-analysis-tool-version
      • code-scanning-analysis-tool
      • code-scanning-ref
      • code-scanning-analysis-analysis-key
      • code-scanning-alert-environment
      • code-scanning-analysis-category
      • code-scanning-alert-location
      • code-scanning-alert-classification
      • code-scanning-alert-instance
      • Simple Repository
      • code-scanning-organization-alert-items
      • Enterprise Security Analysis Settings
      • dependabot-alert-package
      • dependabot-alert-security-vulnerability
      • dependabot-alert-security-advisory
      • alert-auto-dismissed-at
      • dependabot-alert-with-repository
      • nullable-alert-updated-at
      • secret-scanning-alert-state
      • secret-scanning-alert-resolution
      • organization-secret-scanning-alert
      • advanced-security-active-committers-user
      • advanced-security-active-committers-repository
      • advanced-security-active-committers
      • Actor
      • Milestone
      • GitHub app
      • author_association
      • Reaction Rollup
      • Issue
      • Issue Comment
      • Event
      • Link With Type
      • Feed
      • Base Gist
      • Public User
      • Gist History
      • Gist Simple
      • Gist Comment
      • Gist Commit
      • Gitignore Template
      • License Simple
      • License
      • ghes-cluster-topology
      • ghes-cluster-roles
      • ghes-config-nodes
      • ghes-replication-status-indicator
      • ghes-replication-status
      • ghes-version
      • Api Overview
      • security-and-analysis
      • Minimal Repository
      • Thread
      • Thread Subscription
      • Organization Custom Repository Role
      • Organization Full
      • Actions Cache Usage by repository
      • Actions OIDC Subject customization
      • Empty Object
      • enabled-repositories
      • actions-organization-permissions
      • runner-groups-org
      • Actions Secret for an Organization
      • ActionsPublicKey
      • Actions Variable for an Organization
      • announcement-user-dismissible
      • Announcement Banner
      • code-scanning-alert-severity
      • organization-custom-repository-role-create-schema
      • organization-custom-repository-role-update-schema
      • Dependabot Secret for an Organization
      • DependabotPublicKey
      • Minimal Repository
      • Package
      • ExternalGroup
      • ExternalGroups
      • Org Hook
      • Org Membership
      • Migration
      • Package Version
      • org-pre-receive-hook
      • Project
      • Repository
      • Code Of Conduct Simple
      • Full Repository
      • Repository Fine-Grained Permission
      • Team Simple
      • Team Simple
      • Team
      • Team Organization
      • Full Team
      • Team Discussion
      • Team Discussion Comment
      • Reaction
      • Team Membership
      • Team Project
      • Team Repository
      • Project Card
      • Project Column
      • Project Collaborator Permission
      • Rate Limit
      • Rate Limit Overview
      • Artifact
      • Actions cache usage policy for repository
      • Repository actions caches
      • Job
      • Actions OIDC subject customization for a repository
      • Actions Secret
      • Actions Variable
      • actions-enabled
      • actions-repository-permissions
      • actions-workflow-access-to-repository
      • Referenced workflow
      • Pull Request Minimal
      • Simple Commit
      • Workflow Run
      • Environment Approval
      • deployment-reviewer-type
      • Pending Deployment
      • Deployment
      • Workflow
      • Autolink reference
      • Protected Branch Required Status Check
      • Protected Branch Admin Enforced
      • Protected Branch Pull Request Review
      • Branch Restriction Policy
      • Branch Protection
      • Short Branch
      • Git User
      • Verification
      • Diff Entry
      • Commit
      • Branch With Protection
      • Status Check Policy
      • Protected Branch
      • Deployment
      • CheckRun
      • Check Annotation
      • Simple Commit
      • CheckSuite
      • Check Suite Preference
      • code-scanning-alert-items
      • code-scanning-alert-rule
      • code-scanning-alert
      • code-scanning-alert-set-state
      • code-scanning-analysis-sarif-id
      • code-scanning-analysis-commit-sha
      • code-scanning-analysis-environment
      • code-scanning-analysis-created-at
      • code-scanning-analysis-url
      • code-scanning-analysis
      • Analysis deletion
      • code-scanning-default-setup
      • code-scanning-default-setup-update
      • code-scanning-default-setup-update-response
      • code-scanning-ref-full
      • code-scanning-analysis-sarif-file
      • code-scanning-sarifs-receipt
      • code-scanning-sarifs-status
      • CODEOWNERS errors
      • Collaborator
      • Collaborator
      • Repository Collaborator Permission
      • Commit Comment
      • Branch Short
      • Link
      • Auto merge
      • Pull Request Simple
      • Simple Commit Status
      • Combined Commit Status
      • Status
      • Commit Comparison
      • Content Tree
      • Content Directory
      • Content File
      • Symlink Content
      • Submodule Content
      • File Commit
      • Contributor
      • dependabot-alert
      • Dependabot Secret
      • Dependency Graph Diff
      • Dependency Graph SPDX SBOM
      • metadata
      • dependency
      • manifest
      • snapshot
      • Deployment Status
      • wait-timer
      • deployment-branch-policy-settings
      • Environment
      • Deployment branch policy
      • Deployment branch and tag policy name pattern
      • Deployment branch policy name pattern
      • Short Blob
      • Blob
      • Git Commit
      • Git Reference
      • Git Tag
      • Git Tree
      • Hook Response
      • Webhook
      • Repository Invitation
      • Issue
      • Issue Event Label
      • Issue Event Dismissed Review
      • Issue Event Milestone
      • Issue Event Project Card
      • Issue Event Rename
      • Issue Event
      • Labeled Issue Event
      • Unlabeled Issue Event
      • Assigned Issue Event
      • Unassigned Issue Event
      • Milestoned Issue Event
      • Demilestoned Issue Event
      • Renamed Issue Event
      • Review Requested Issue Event
      • Review Request Removed Issue Event
      • Review Dismissed Issue Event
      • Locked Issue Event
      • Added to Project Issue Event
      • Moved Column in Project Issue Event
      • Removed from Project Issue Event
      • Converted Note to Issue Issue Event
      • Issue Event for Issue
      • Label
      • Timeline Comment Event
      • Timeline Cross Referenced Event
      • Timeline Committed Event
      • Timeline Reviewed Event
      • Pull Request Review Comment
      • Timeline Line Commented Event
      • Timeline Commit Commented Event
      • Timeline Assigned Issue Event
      • Timeline Unassigned Issue Event
      • State Change Issue Event
      • Timeline Event
      • Deploy Key
      • Language
      • License Content
      • Merged upstream
      • Milestone
      • Pages Source Hash
      • Pages Https Certificate
      • GitHub Pages
      • Page Build
      • Page Build Status
      • GitHub Pages
      • repository-pre-receive-hook
      • Pull Request
      • Pull Request Merge Result
      • Pull Request Review Request
      • Pull Request Review
      • Legacy Review Comment
      • Release Asset
      • Release
      • Generated Release Notes Content
      • secret-scanning-alert
      • secret-scanning-alert-resolution-comment
      • secret-scanning-location-commit
      • secret-scanning-location-issue-title
      • secret-scanning-location-issue-body
      • secret-scanning-location-issue-comment
      • secret-scanning-location-discussion-title
      • secret-scanning-location-discussion-body
      • secret-scanning-location-discussion-comment
      • secret-scanning-location-pull-request-title
      • secret-scanning-location-pull-request-body
      • secret-scanning-location-pull-request-comment
      • secret-scanning-location-pull-request-review
      • secret-scanning-location-pull-request-review-comment
      • secret-scanning-location
      • Stargazer
      • Code Frequency Stat
      • Commit Activity
      • Contributor Activity
      • Participation Stats
      • Repository Invitation
      • Tag
      • Tag protection
      • Topic
      • group-response
      • meta
      • scim-enterprise-group-response
      • scim-enterprise-group-list
      • group
      • patch-schema
      • user-name-response
      • user-emails-response
      • user-role
      • user-response
      • scim-enterprise-user-response
      • scim-enterprise-user-list
      • user-name
      • user-emails
      • user
      • Search Result Text Matches
      • Code Search Result Item
      • Commit Search Result Item
      • Issue Search Result Item
      • Label Search Result Item
      • Repo Search Result Item
      • Topic Search Result Item
      • User Search Result Item
      • configuration-status
      • maintenance-status
      • enterprise-settings
      • ssh-key
      • Private User
      • Email
      • GPG Key
      • Key
      • Social account
      • SSH Signing Key
      • Starred Repository
      • Hovercard
      • Key Simple
      • Enterprise
      • Simple Installation
      • Organization Simple
      • Repository
      • branch protection rule
      • Simple User
      • simple-check-suite
      • CheckRun
      • webhooks_code_scanning_commit_oid
      • webhooks_code_scanning_ref
      • webhooks_deploy_pusher_type
      • webhooks_ref_0
      • webhooks_deploy_key
      • Workflow
      • webhooks_approver
      • webhooks_reviewers
      • webhooks_workflow_job_run
      • User
      • webhooks_answer
      • Discussion
      • webhooks_comment
      • Label
      • webhooks_repositories
      • webhooks_repositories_added
      • webhooks_repository_selection
      • issue comment
      • webhooks_changes
      • Issue
      • Milestone
      • Issue
      • User
      • Team
      • Repository
      • Milestone
      • Membership
      • Project Card
      • Project
      • Project Column
      • Projects v2 Project
      • webhooks_project_changes
      • Projects v2 Item Content Type
      • Projects v2 Item
      • webhooks_number
      • pull-request-webhook
      • Pull Request
      • Pull Request Review Comment
      • webhooks_review
      • webhooks_nullable_string
      • Release
      • Release
      • Repository Vulnerability Alert Alert
      • secret-scanning-alert-resolution-webhook
      • secret-scanning-alert-webhook
      • webhooks_security_advisory
      • webhooks_sponsorship
      • webhooks_effective_date
      • webhooks_changes_8
      • Team
      • branch protection rule created event
      • branch protection rule deleted event
      • branch protection rule edited event
      • webhook-cache-sync
      • Check Run Completed Event
      • Check Run Completed Event
      • Check Run Created Event
      • Check Run Created Event
      • Check Run Requested Action Event
      • Check Run Requested Action Event
      • Check Run Re-Requested Event
      • Check Run Re-Requested Event
      • check_suite completed event
      • check_suite requested event
      • check_suite rerequested event
      • code_scanning_alert appeared_in_branch event
      • code_scanning_alert closed_by_user event
      • code_scanning_alert created event
      • code_scanning_alert fixed event
      • code_scanning_alert reopened event
      • code_scanning_alert reopened_by_user event
      • commit_comment created event
      • create event
      • delete event
      • Dependabot alert created event
      • Dependabot alert dismissed event
      • Dependabot alert fixed event
      • Dependabot alert reintroduced event
      • Dependabot alert reopened event
      • deploy_key created event
      • deploy_key deleted event
      • deployment created event
      • webhook-deployment-review-approved
      • webhook-deployment-review-rejected
      • webhook-deployment-review-requested
      • deployment_status created event
      • discussion answered event
      • discussion category changed event
      • discussion closed event
      • discussion_comment created event
      • discussion_comment deleted event
      • discussion_comment edited event
      • discussion created event
      • discussion deleted event
      • discussion edited event
      • discussion labeled event
      • discussion locked event
      • discussion pinned event
      • discussion reopened event
      • discussion transferred event
      • discussion unanswered event
      • discussion unlabeled event
      • discussion unlocked event
      • discussion unpinned event
      • webhook-enterprise-anonymous-access-disabled
      • webhook-enterprise-anonymous-access-enabled
      • fork event
      • github_app_authorization revoked event
      • gollum event
      • installation created event
      • installation deleted event
      • installation new_permissions_accepted event
      • installation_repositories added event
      • installation_repositories removed event
      • installation suspend event
      • webhook-installation-target-renamed
      • installation unsuspend event
      • issue_comment created event
      • issue_comment deleted event
      • issue_comment edited event
      • issues assigned event
      • issues closed event
      • issues deleted event
      • issues demilestoned event
      • issues edited event
      • issues labeled event
      • issues locked event
      • issues milestoned event
      • issues opened event
      • issues pinned event
      • issues reopened event
      • issues transferred event
      • issues unassigned event
      • issues unlabeled event
      • issues unlocked event
      • issues unpinned event
      • label created event
      • label deleted event
      • label edited event
      • member added event
      • member edited event
      • member removed event
      • membership added event
      • membership removed event
      • meta deleted event
      • milestone closed event
      • milestone created event
      • milestone deleted event
      • milestone edited event
      • milestone opened event
      • organization deleted event
      • organization member_added event
      • organization member_invited event
      • organization member_removed event
      • organization renamed event
      • Ruby Gems metadata
      • package published event
      • package updated event
      • page_build event
      • webhook-ping
      • webhook-ping-form-encoded
      • project_card converted event
      • project_card created event
      • project_card deleted event
      • project_card edited event
      • project_card moved event
      • project closed event
      • project_column created event
      • project_column deleted event
      • project_column edited event
      • project_column moved event
      • project created event
      • project deleted event
      • project edited event
      • project reopened event
      • Projects v2 Project Closed Event
      • webhook-projects-v2-project-created
      • Projects v2 Project Deleted Event
      • Projects v2 Project Edited Event
      • Projects v2 Item Archived Event
      • Projects v2 Item Converted Event
      • Projects v2 Item Created Event
      • Projects v2 Item Deleted Event
      • Projects v2 Item Edited Event
      • Projects v2 Item Reordered Event
      • Projects v2 Item Restored Event
      • Projects v2 Project Reopened Event
      • public event
      • pull_request assigned event
      • pull_request auto_merge_disabled event
      • pull_request auto_merge_enabled event
      • pull_request closed event
      • pull_request converted_to_draft event
      • pull_request demilestoned event
      • pull_request edited event
      • pull_request labeled event
      • pull_request locked event
      • pull_request milestoned event
      • pull_request opened event
      • pull_request ready_for_review event
      • pull_request reopened event
      • pull_request_review_comment created event
      • pull_request_review_comment deleted event
      • pull_request_review_comment edited event
      • pull_request_review dismissed event
      • pull_request_review edited event
      • pull_request_review submitted event
      • pull_request_review_thread resolved event
      • pull_request_review_thread unresolved event
      • pull_request synchronize event
      • pull_request unassigned event
      • pull_request unlabeled event
      • pull_request unlocked event
      • push event
      • webhook-registry-package-published
      • webhook-registry-package-updated
      • release created event
      • release deleted event
      • release edited event
      • release prereleased event
      • release published event
      • release released event
      • release unpublished event
      • webhook-repository-anonymous-access-disabled
      • webhook-repository-anonymous-access-enabled
      • repository archived event
      • repository created event
      • repository deleted event
      • repository_dispatch event
      • repository edited event
      • repository privatized event
      • repository publicized event
      • repository renamed event
      • repository transferred event
      • repository unarchived event
      • repository_vulnerability_alert create event
      • repository_vulnerability_alert dismiss event
      • repository_vulnerability_alert reopen event
      • repository_vulnerability_alert resolve event
      • secret_scanning_alert created event
      • Secret Scanning Alert Location Created Event
      • Secret Scanning Alert Location Created Event
      • secret_scanning_alert reopened event
      • secret_scanning_alert resolved event
      • security_advisory published event
      • security_advisory updated event
      • security_advisory withdrawn event
      • security_and_analysis event
      • sponsorship cancelled event
      • sponsorship created event
      • sponsorship edited event
      • sponsorship pending_cancellation event
      • sponsorship pending_tier_change event
      • sponsorship tier_changed event
      • star created event
      • star deleted event
      • status event
      • team_add event
      • team added_to_repository event
      • team created event
      • team deleted event
      • team edited event
      • team removed_from_repository event
      • webhook-user-created
      • webhook-user-deleted
      • watch started event
      • workflow_dispatch event
      • workflow_job completed event
      • workflow_job in_progress event
      • workflow_job queued event
      • workflow_job waiting event
      • workflow_run completed event
      • workflow_run in_progress event
      • workflow_run requested event
    • Response
      • not_found
      • validation_failed_simple
      • bad_request
      • validation_failed
      • accepted
      • requires_authentication
      • forbidden
      • gone
      • actions_runner_labels
      • actions_runner_labels_readonly
      • service_unavailable
      • code_scanning_forbidden_read
      • forbidden_gist
      • moved_permanently
      • conflict
      • temporary_redirect
      • internal_error
      • code_scanning_forbidden_write
      • code_scanning_conflict
      • dependency_review_forbidden
      • unacceptable
      • scim_bad_request
      • scim_too_many_requests
      • scim_internal_error
  1. enterprise-admin

Start a pre-receive environment download

POST
/admin/pre-receive-environments/{pre_receive_environment_id}/downloads
Triggers a new download of the environment tarball from the environment's image_url. When the download is finished, the newly downloaded tarball will overwrite the existing environment.
If a download cannot be triggered, you will receive a 422 Unprocessable Entity response.
The possible error messages are:
Cannot modify or delete the default environment
Can not start a new download when a download is in progress

リクエストパラメータ

パスパラメータ

レスポンス

🟢202Accepted
application/json
Response
ボディapplication/json

🟠422Parameter Error
リクエストリクエストExample
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://service1.exmaple.com/admin/pre-receive-environments//downloads'
レスポンスレスポンスExample
202 - default-response
{
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest",
    "state": "not_started",
    "downloaded_at": null,
    "message": null
}
更新日時 2025-06-12 06:47:18
前へ
Delete a pre-receive environment
次へ
Get the download status for a pre-receive environment
Built with