The GitHub App API is the set of REST/GraphQL endpoints and webhooks that lets a GitHub App securely integrate with and automate work across GitHub. Apps authenticate with a sho...
The GitHub Authorization (OAuth Authorizations) API historically let you programmatically create, list, inspect, and revoke access tokens for a user or OAuth applicationsetting ...
GitHubs Code of Conduct API lets apps discover and retrieve the community codes of conduct that GitHub supports and see which one a repository has adopted. Through REST endpoint...
The GitHub Emojis API is a simple REST endpoint (GET /emojis or https://api.github.com/emojis) that returns a JSON dictionary mapping emoji shortcodes (like "smile" or "octocat"...
The GitHub Events API provides a read-only feed of recent activity on GitHub, exposing structured event objects you can poll to see what happened across the platform or within a...
GitHubs Feeds API lets you programmatically discover the Atom feed URLs for GitHub activity thats relevant to you, such as the global timeline, a specific users activity, the au...
The GitHub Gists API lets you programmatically manage gistslightweight code snippets and notesover HTTP. You can create gists (public or secret/unlisted), read individual gists,...
The GitHub Gitignore Templates API is a REST interface that lets you discover and fetch canonical .gitignore templates maintained by GitHub, so you can programmatically create i...
The GitHub Installation API is part of the GitHub Apps platform and lets an app understand and manage where its installed and what it can access, and act on behalf of that insta...
The GitHub Issues API lets you programmatically manage issue tracking on GitHub, enabling you to list and filter issues across repositories, create and edit issues, change their...
The GitHub Licenses API lets you programmatically discover and retrieve open source license information across GitHub. It provides endpoints to list the common licenses GitHub s...
The GitHub Enterprise Management API lets administrators automate and integrate the operational and security management of their enterprise on GitHub. It covers tasks like provi...
The GitHub Markdown API is a REST service that converts Markdownespecially GitHub Flavored Markdowninto the same HTML GitHub renders in READMEs, issues, and pull requests, so ex...
Use the REST API to get meta information about GitHub, including the IP addresses of GitHub services.
GitHubs Networks API lets you retrieve a stream of public activity that occurs across a repositorys network, meaning the original repo and all of its forks. Exposed via the Even...
This GitHub REST API allows you to programmatically manage your GitHub notifications, which include updates on issues, pull requests, and commits. The API requires authenticatio...
The GitHub Octocat API is a playful, non-functional endpoint in GitHubs REST API that returns an ASCII-art rendering of the Octocat mascot as plain text. Its primarily meant for...
The GitHub Organization API lets you programmatically administer and integrate with organizations on GitHub, spanning both REST and GraphQL. It covers core governance tasks such...
The GitHub Projects API enables developers to programmatically create and manage GitHub Projects, which are flexible tools for planning and tracking work using customizable boar...
GitHubs Rate Limit API lets you programmatically see how much API quota you have left and when it will reset, so you can avoid hitting API rate limit exceeded errors. By calling...
The GitHub Repos API is a set of REST endpoints that let you programmatically create, read, update, and delete repositories and their resources, giving you control over a repos ...
GitHubs SCIM API implements the SCIM 2.0 standard to automate user lifecycle management from an identity provider (such as Entra ID/Azure AD, Okta, or OneLogin) to GitHub Enterp...
The GitHub Search API lets you programmatically find and filter content across GitHubincluding repositories, code, issues and pull requests, commits, users, topics, and labelsus...
The GitHub Setup API is the administrative interface for GitHub Enterprise Server that lets you automate tasks normally done in the Management Console during first-time and ongo...
The GitHub Teams API lets you programmatically manage organization teams and the access they grant. With it, you can create, update, and delete teams; organize parent/child team...
The GitHub Zen API is a playful REST endpoint that returns a random aphorism from the Zen of GitHub, such as Keep it logically awesome. Each request to GET https://api.github.co...
The GitHub Users API (part of the REST API) lets applications read and, for the authenticated account, manage user-related data on GitHub. It can fetch public profiles for any u...
The GitHub Actions API lets you manage and automate GitHub Actions workflows, including creating and managing workflow runs, jobs, artifacts, caches, secrets, variables, self-ho...
The GitHub Branches API lets you list, create, and manage branches in a repository, including configuring branch protection rules that enforce required status checks, pull reque...
The GitHub Code Scanning API lets you retrieve and manage code scanning alerts for a repository. Code scanning uses CodeQL or third-party analysis tools to find potential securi...
The GitHub Collaborators API lets you manage access to repositories by adding, removing, and listing collaborators, checking permissions, and managing repository invitations. It...
The GitHub Dependabot API lets you manage Dependabot alerts and secrets for repositories and organizations. It provides endpoints to list, get, and update Dependabot alerts for ...
The GitHub Webhooks API lets you create and manage webhooks for repositories and organizations. Webhooks deliver HTTP POST payloads to a configured URL whenever specified events...
The GitHub Pull Requests API lets you create, list, update, and merge pull requests in a repository. It provides endpoints for managing pull request reviews, review comments, re...
The GitHub Tags API lets you create and manage Git tag objects in a repository. Tags are references that point to specific commits, commonly used to mark release points. The API...
The GitHub Checks API lets you create and manage check runs and check suites that report detailed status, annotations, and results for commits. It enables CI/CD tools and integr...
The GitHub Deployments API lets you create and manage deployments and deployment statuses for repositories. Deployments are requests to deploy a specific ref (branch, SHA, tag) ...
The GitHub Releases API lets you create, edit, and delete releases for a repository, as well as upload and manage release assets (binaries, installers, archives). Releases are b...
The GitHub Pages API lets you manage GitHub Pages sites for repositories, including creating, updating, and deleting sites, configuring custom domains and HTTPS enforcement, and...
The GitHub Packages API lets you manage packages and package versions in GitHub Packages, a software package hosting service that supports npm, Maven, Gradle, RubyGems, NuGet, D...
The GitHub Git Database API provides low-level access to Git objects (blobs, commits, refs, tags, and trees) in a repository. It lets you read and write raw Git data directly, e...
The GitHub Codespaces API lets you create, manage, start, stop, and delete cloud development environments (codespaces) for repositories. It provides endpoints for managing codes...
The GitHub Copilot API lets organization and enterprise owners manage GitHub Copilot seat assignments, retrieve usage metrics and billing information, and configure Copilot poli...
The GitHub Billing API lets you view billing and usage information for organizations and enterprises, including Actions minutes, Packages storage and data transfer, Codespaces u...
The GitHub Migrations API lets you migrate data to and from GitHub. It supports organization migrations that export repositories and metadata as downloadable archives, source im...
The GitHub Secret Scanning API lets you retrieve and manage secret scanning alerts for repositories, organizations, and enterprises. Secret scanning detects tokens, keys, and ot...
The GitHub Security Advisories API lets you view and manage security advisories for repositories and access the GitHub Advisory Database. It provides endpoints to create, update...
The GitHub Commits API lets you list, retrieve, and compare commits in a repository, as well as manage commit comments and commit statuses. It provides endpoints for viewing com...
The GitHub Reactions API lets you create, list, and delete emoji reactions on issues, pull requests, issue comments, pull request review comments, commit comments, release asset...
The GitHub Deploy Keys API lets you manage deploy keys for repositories. Deploy keys are SSH keys that grant read-only or read-write access to a single repository, commonly used...
The GitHub Dependency Graph API lets you view and submit dependency information for a repository. It provides endpoints to export the software bill of materials (SBOM) for a rep...
The GitHub Metrics API lets you access community profile and repository statistics, including contributor activity, commit frequency, code frequency, participation data, punch c...
The GitHub Interactions API lets you temporarily restrict which users can comment, open issues, or create pull requests in public repositories. It supports setting interaction l...
The GitHub Models API provides access to the GitHub Models catalog, letting you list and retrieve details about AI models available on the GitHub platform. It supports browsing ...
The GitHub GraphQL API provides a flexible query language for accessing GitHub data, allowing clients to request exactly the fields they need in a single request. It supports qu...
The GitHub Campaigns API lets organization owners and security managers create and manage security campaigns that coordinate remediation of code scanning alerts across multiple ...
The GitHub Classroom API lets you programmatically interact with GitHub Classroom, providing endpoints to list classrooms, get classroom details, list assignments for a classroo...
The GitHub Code Security API lets organizations and enterprises create and manage reusable code security configurations that standardize security settings across repositories. I...
The GitHub Credentials API lets you programmatically manage authentication credentials, providing endpoints to revoke a list of credentials such as tokens and keys for security ...
The GitHub Enterprise Teams API lets enterprise owners create and manage enterprise-level teams. It provides endpoints to list, create, get, update, and delete teams, manage tea...
The GitHub Private Registries API lets organizations configure and manage private package registries. It provides endpoints to list, create, get, update, and delete private regi...
The GitHub Autolinks API lets repository administrators manage autolink references that automatically link issues, pull requests, commit messages, and release descriptions to ex...
The GitHub Starring API lets you bookmark repositories and manage your starred list. It provides endpoints to list stargazers for a repository, list repositories starred by the ...
The GitHub Watching API lets you subscribe to notifications for activity in a repository. It provides endpoints to list watchers of a repository, get and set a repository subscr...
The GitHub Repository Invitations API lets you manage repository collaboration invitations. It provides endpoints to list repository invitations, update an invitation, delete an...
REST API and GraphQL API for repositories, issues, PRs, releases, and Actions
GitHub Apps with up to 15,000 requests/hour on Enterprise Cloud
OAuth App authorization and fine-grained personal access tokens
GitHub Actions workflow execution with self-hosted and GitHub-hosted runners
GitHub Packages container, npm, Maven, NuGet, RubyGems, and Gradle registries
GitHub Codespaces cloud development environments
GitHub Copilot AI pair programmer (separate per-seat licensing)
Audit log API and webhook event delivery
Branch protection, required reviewers, code owners, environments
Secondary rate limits: 100 concurrent / 900 points-per-minute / 80 content-generating-per-minute
Git LFS API at 3,000 requests/minute (authenticated)
Conditional requests with ETag/If-None-Match return 304 without consuming rate limit
OIDC token exchange for cloud provider federation
SAML SSO, SCIM, and SSH certificate authority on Enterprise Cloud
GitHub Marketplace for app distribution and billing
opencollection: 1.0.0
info:
name: GitHub Repos API
version: 1.1.4
items:
- info:
name: Repositories
type: folder
items:
- info:
name: List Repositories Accessible To The App Installation
type: http
http:
method: GET
url: '{protocol}://{hostname}/installation/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: List repositories that an app installation can access.
- info:
name: Actions
type: folder
items:
- info:
name: List Selected Repositories Enabled For Github Actions In An Organization
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/actions/permissions/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the
organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see
"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
- info:
name: Set Selected Repositories Enabled For Github Actions In An Organization
type: http
http:
method: PUT
url: '{protocol}://{hostname}/orgs/:org/actions/permissions/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
body:
type: json
data: '{}'
docs: 'Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this
endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information,
see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
- info:
name: Enable Selected Repository For Github Actions In An Organization
type: http
http:
method: PUT
url: '{protocol}://{hostname}/orgs/:org/actions/permissions/repositories/:repository_id'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: repository_id
value: ''
type: path
description: The unique identifier of the repository.
docs: 'Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization.
To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`.
For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
- info:
name: Disable Selected Repository For Github Actions In An Organization
type: http
http:
method: DELETE
url: '{protocol}://{hostname}/orgs/:org/actions/permissions/repositories/:repository_id'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: repository_id
value: ''
type: path
description: The unique identifier of the repository.
docs: Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization.
To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`.
For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
- info:
name: Lists
type: folder
items:
- info:
name: List Repository Access To Self-hosted Runner Group In An Organization
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/actions/runner-groups/:runner_group_id/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: runner_group_id
value: ''
type: path
description: Unique identifier of the self-hosted runner group.
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists the repositories with access to a self-hosted runner group configured in an organization.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
- info:
name: List Selected Repositories For An Organization Secret
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/actions/secrets/:secret_name/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: secret_name
value: ''
type: path
description: The name of the secret.
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository
is private, the `repo` scope is also required.'
- info:
name: List Selected Repositories For An Organization Variable
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/actions/variables/:name/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: name
value: ''
type: path
description: The name of the variable.
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists all repositories that can access an organization variable
that is available to selected repositories.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository
is private, the `repo` scope is also required.'
- info:
name: List Selected Repositories For An Organization Secret
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/dependabot/secrets/:secret_name/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: secret_name
value: ''
type: path
description: The name of the secret.
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
- info:
name: List Repositories In An Organization Migration
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/migrations/:migration_id/repositories'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: migration_id
value: ''
type: path
description: The unique identifier of the migration.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: List all the repositories for this organization migration.
- info:
name: List Organization Repositories
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/repos'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: type
value: ''
type: query
description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub
App calls this endpoint with an installation access token.
- name: sort
value: ''
type: query
description: The property to sort the results by.
- name: direction
value: ''
type: query
description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.'
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists repositories for the specified organization.
**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the
repository or be an owner or security manager for the organization that owns the repository. For more information, see
"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organizati'
- info:
name: List Repository Fine-grained Permissions For An Organization
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/repository-fine-grained-permissions'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
docs: 'Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information,
see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)."
The authenticated user must be an administrator of the organization or of a repository of the organization to use this
endpoint.
OAuth app tokens and personal access tokens (classic) need th'
- info:
name: List Team Repositories
type: http
http:
method: GET
url: '{protocol}://{hostname}/orgs/:org/teams/:team_slug/repos'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: org
value: ''
type: path
description: The organization name. The name is not case sensitive.
- name: team_slug
value: ''
type: path
description: The slug of the team name.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists a team''s repositories visible to the authenticated user.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.'
- info:
name: List Artifacts For Repository
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/artifacts'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: name
value: ''
type: query
description: The name field of an artifact. When specified, only artifacts with this name will be returned.
docs: 'Lists all artifacts for a repository.
Anyone with read access to the repository can use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.'
- info:
name: List Github Actions Caches For Repository
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/caches'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: ref
value: ''
type: query
description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch
name>`. To reference a pull request use `refs/pull/<number>/merge`.
- name: key
value: ''
type: query
description: An explicit key or prefix for identifying the cache
- name: sort
value: ''
type: query
description: The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at`
means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.
- name: direction
value: ''
type: query
description: The direction to sort the results by.
docs: 'Lists the GitHub Actions caches for a repository.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
- info:
name: List Repository Organization Secrets
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/organization-secrets'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists all organization secrets shared with a repository without revealing their encrypted
values.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
- info:
name: List Repository Organization Variables
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/organization-variables'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
- name: per_page
value: ''
type: query
description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists all organization variables shared with a repository.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
- info:
name: List Self-hosted Runners For Repository
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/runners'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
docs: 'Lists all self-hosted runners configured in a repository.
Authenticated users must have admin access to the repository to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
- info:
name: List Runner Applications For Repository
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/runners/downloads'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
docs: 'Lists binaries for the runner application that you can download and run.
Authenticated users must have admin access to the repository to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
- info:
name: List Labels For Self-hosted Runner For Repository
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/runners/:runner_id/labels'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
- name: runner_id
value: ''
type: path
description: Unique identifier of the self-hosted runner.
docs: 'Lists all labels for a self-hosted runner configured in a repository.
Authenticated users must have admin access to the repository to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
- info:
name: List Workflow Runs For Repository
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/runs'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
description: The name of the repository without the `.git` extension. The name is not case sensitive.
- name: actor
value: ''
type: query
description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the
check suite or workflow run.
- name: branch
value: ''
type: query
description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`.
- name: event
value: ''
type: query
description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`.
For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)."
- name: status
value: ''
type: query
description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion
can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`,
or `requested`.
- name: per_page
value: ''
type: query
description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: page
value: ''
type: query
description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- name: created
value: ''
type: query
description: Returns workflow runs created within the given date-time range. For more information on the syntax, see
"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
- name: exclude_pull_requests
value: ''
type: query
description: If `true` pull requests are omitted from the response (empty array).
- name: check_suite_id
value: ''
type: query
description: Returns workflow runs with the `check_suite_id` that you specify.
- name: head_sha
value: ''
type: query
description: Only returns workflow runs that are associated with the specified `head_sha`.
docs: 'Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).
Anyone with read access to the repository can use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.'
- info:
name: List Workflow Run Artifacts
type: http
http:
method: GET
url: '{protocol}://{hostname}/repos/:owner/:repo/actions/runs/:run_id/artifacts'
headers:
- name: Authorization
value: ''
- name: X-GitHub-Api-Version
value: ''
- name: Accept
value: ''
params:
- name: owner
value: ''
type: path
description: The account owner of the repository. The name is not case sensitive.
- name: repo
value: ''
type: path
# --- truncated at 32 KB (560 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/apis.yml