text stringlengths 12 91.7k | metadata dict |
|---|---|
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/branches/branch-protection.md",
"title": "REST API endpoints for protected branches"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/branches/branches.md",
"title": "REST API endpoints for branches"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/branches/index.md",
"title": "REST API endpoints for branches and their settings"
} |
[!NOTE]
These endpoints only interact with published campaigns. Draft campaigns cannot currently be viewed or managed through the API.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/campaigns/campaigns.md",
"title": "REST API endpoints for security campaigns"
} |
You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see AUTOTITLE and AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/checks/index.md",
"title": "REST API endpoints for checks"
} |
[!NOTE]
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/checks/runs.md",
"title": "REST API endpoints for check runs"
} |
[!NOTE]
[!NOTE]
A GitHub App usually only receives one checksuite event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch create events.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/checks/suites.md",
"title": "REST API endpoints for check suites"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/classroom/classroom.md",
"title": "REST API endpoints for {% data variables.product.prodname_classroom %}"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/code-quality/code-quality.md",
"title": "REST API endpoints for code quality"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/code-scanning/alert-dismissal-requests.md",
"title": ">-"
} |
About code scanning
You can retrieve and update alerts from a repository. You can use the endpoints to create automated reports for the alerts in an organization or upload analysis results generated using offline tools. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -... | {
"source": "github-docs/rest/code-scanning/code-scanning.md",
"title": "REST API endpoints for code scanning"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/code-scanning/index.md",
"title": "REST API endpoints for code scanning"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/code-security/configurations.md",
"title": "Configurations"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/codes-of-conduct/codes-of-conduct.md",
"title": "REST API endpoints for codes of conduct"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/codes-of-conduct/index.md",
"title": "REST API endpoints for codes of conduct"
} |
About
You can manage using the REST API. These endpoints are available for authenticated users, , and . For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/codespaces/codespaces.md",
"title": "REST API endpoints for Codespaces"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/codespaces/index.md",
"title": "REST API endpoints for Codespaces"
} |
About machines
You can determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see AUTOTITLE.
You can also use this information when changing the machine of an existing codespace by updating its machine property. The machine upd... | {
"source": "github-docs/rest/codespaces/machines.md",
"title": "REST API endpoints for Codespaces machines"
} |
[!NOTE]
These endpoints are currently in and subject to change.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/codespaces/organization-secrets.md",
"title": "REST API endpoints for Codespaces organization secrets"
} |
About organizations
You can manage that are billed to your
organization. For more information,
see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/codespaces/organizations.md",
"title": "REST API endpoints for Codespaces organizations"
} |
About repository secrets
You can create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/codespaces/repository-secrets.md",
"title": "REST API endpoints for Codespaces repository secrets"
} |
About user secrets
You can create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see AUTOTITLE.
<!-- Content after this section is automatical... | {
"source": "github-docs/rest/codespaces/secrets.md",
"title": "REST API endpoints for Codespaces user secrets"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/collaborators/collaborators.md",
"title": "REST API endpoints for collaborators"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/collaborators/index.md",
"title": "REST API endpoints for collaborators"
} |
About repository invitations
You can view and manage invitations to collaborate on a repository. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations.
To add a user as a collaborator, use the Collaborators endpoints instead. For more information, see AUTOTI... | {
"source": "github-docs/rest/collaborators/invitations.md",
"title": "REST API endpoints for repository invitations"
} |
About commit comments
You can create, edit, and view commit comments using the REST API. A commit comment is a comment made on a specific commit. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/commits/comments.md",
"title": "REST API endpoints for commit comments"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/commits/commits.md",
"title": "REST API endpoints for commits"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/commits/index.md",
"title": "REST API endpoints for commits"
} |
About commit statuses
You can use the REST API to allow external services to mark commits with an error, failure, pending, or success state, which is then reflected in pull requests involving those commits. Statuses can also include an optional description and targeturl, and we highly recommend providing them as they m... | {
"source": "github-docs/rest/commits/statuses.md",
"title": "REST API endpoints for commit statuses"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot/copilot-cloud-agent-management.md",
"title": "REST API endpoints for Copilot cloud agent repository management"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot/copilot-coding-agent-management.md",
"title": "REST API endpoints for Copilot cloud agent management"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot/copilot-content-exclusion-management.md",
"title": "REST API endpoints for Copilot content exclusion management"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot/copilot-custom-agents.md",
"title": "REST API endpoints for Copilot custom agents"
} |
To enable these endpoints, the " usage metrics" policy must be set to Enabled everywhere for the enterprise. See AUTOTITLE.
For more information on the metrics returned by these endpoints, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot/copilot-usage-metrics.md",
"title": "REST API endpoints for Copilot usage metrics"
} |
[!NOTE] These endpoints are in and subject to change.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot/copilot-user-management.md",
"title": "REST API endpoints for Copilot user management"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot-spaces/collaborators.md",
"title": "Copilot Spaces collaborators"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot-spaces/copilot-spaces.md",
"title": "REST API endpoints for Copilot Spaces"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/copilot-spaces/resources.md",
"title": "REST API endpoints for Copilot Spaces resources"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/credentials/revoke.md",
"title": "Revocation"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/dependabot/alert-dismissal-requests.md",
"title": "REST API endpoints for {% data variables.product.prodname_dependabot %} alert dismissal requests"
} |
[!NOTE]
The ability to use the REST API to manage Dependabot alerts is currently in and subject to change.
About
You can view alerts for a repository and update individual alerts with the REST API. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/dependabot/alerts.md",
"title": "REST API endpoints for {% data variables.product.prodname_dependabot_alerts %}"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/dependabot/index.md",
"title": "REST API endpoints for {% data variables.product.prodname_dependabot %}"
} |
About repository access
You can list repositories that already has access to and set a default repository access level for .
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/dependabot/repository-access.md",
"title": ">-"
} |
About secrets
You can create, update, delete, and retrieve information about encrypted secrets using the REST API. For more information, see AUTOTITLE.
must have the dependabotsecrets permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read secr... | {
"source": "github-docs/rest/dependabot/secrets.md",
"title": "REST API endpoints for Dependabot secrets"
} |
About dependency review
You can use the REST API to view dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For ... | {
"source": "github-docs/rest/dependency-graph/dependency-review.md",
"title": "REST API endpoints for dependency review"
} |
About dependency submissions
You can use the REST API to submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to 's dependency graph feature, providing a more complete picture of all of your project's dependencies.
The dependency graph shows... | {
"source": "github-docs/rest/dependency-graph/dependency-submission.md",
"title": "REST API endpoints for dependency submission"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/dependency-graph/index.md",
"title": "REST API endpoints for the dependency graph"
} |
This article gives details about the REST API endpoint.
[!NOTE]
does not retrieve license information for dependencies, and does not calculate information about dependents, the repositories and packages that depend on a repository. These fields will not be populated in the response.
<!-- Content after this section i... | {
"source": "github-docs/rest/dependency-graph/sboms.md",
"title": "REST API endpoints for software bill of materials (SBOM)"
} |
About deploy keys
Deploy keys can either be set up using the following API endpoints, or by using the web interface. To learn how to set deploy keys up in the web interface, see AUTOTITLE.
You may be unable to create deploy keys if your organization or enterprise owner has set a policy to restrict their use. Furthermo... | {
"source": "github-docs/rest/deploy-keys/deploy-keys.md",
"title": "REST API endpoints for deploy keys"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/deploy-keys/index.md",
"title": "REST API endpoints for deploy keys"
} |
About deployment branch policies
You can use the REST API to specify custom name patterns that branches must match in order to deploy to an environment. The deploymentbranchpolicy.custombranchpolicies property for the environment must be set to true to use these endpoints. To update the deploymentbranchpolicy for an en... | {
"source": "github-docs/rest/deployments/branch-policies.md",
"title": "REST API endpoints for deployment branch policies"
} |
About deployments
Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a deployment event that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without hav... | {
"source": "github-docs/rest/deployments/deployments.md",
"title": "REST API endpoints for deployments"
} |
About deployment environments
For more information about environments, see AUTOTITLE. To manage environment secrets, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/deployments/environments.md",
"title": "REST API endpoints for deployment environments"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/deployments/index.md",
"title": "REST API endpoints for deployments"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/deployments/protection-rules.md",
"title": "REST API endpoints for protection rules"
} |
About deployment statuses
Deployment statuses allow external services to mark deployments with an error, failure, inactive, inprogress, queued, pending, or success state. Systems listening to deploymentstatus events can consume and respond to these statuses. A deployment status can also include an optional description ... | {
"source": "github-docs/rest/deployments/statuses.md",
"title": "REST API endpoints for deployment statuses"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/emojis/emojis.md",
"title": "REST API endpoints for emojis"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/emojis/index.md",
"title": "REST API endpoints for emojis"
} |
About admin stats
These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/admin-stats.md",
"title": "REST API endpoints for admin stats"
} |
About announcements
You can use the REST API to manage the global announcement banner in your enterprise. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/announcement.md",
"title": "REST API endpoints for global announcements"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/audit-log.md",
"title": "REST API endpoints for enterprise audit logs"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/bypass-requests.md",
"title": "REST API endpoints for bypass requests"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/code-security-and-analysis.md",
"title": "REST API endpoints for enterprise security features for code"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/credential-authorizations.md",
"title": "REST API endpoints for enterprise credential authorizations"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/custom-properties-for-orgs.md",
"title": "REST API for organization custom properties in an enterprise"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/custom-properties.md",
"title": "Custom properties"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/enterprise-roles.md",
"title": "REST API endpoints for enterprise roles"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/enterprises.md",
"title": "REST API endpoints for enterprise access verification"
} |
About global webhooks
These endpoints are only available to authenticated site administrators Normal users will receive a 404 response. To learn how to configure global webhooks, see About global webhooks.
Global webhooks are automatically installed on your enterprise. You can use global webhooks to automatically monit... | {
"source": "github-docs/rest/enterprise-admin/global-webhooks.md",
"title": "REST API endpoints for global webhooks"
} |
[!NOTE]
This information applies to . To see the version, use the drop-down menu.
Endpoint URLs
These endpoints, except the Manage GitHub Enterprise Server API, are prefixed with the following URL:
{% data variables.product.rest_url %}
When endpoints include {enterprise}, replace {enterprise} with the handle for yo... | {
"source": "github-docs/rest/enterprise-admin/index.md",
"title": "REST API endpoints for GitHub Enterprise administration"
} |
About LDAP
You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have LDAP Sync enabled for your appliance. The Update LDAP mapping for a user endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled.
<!-- Content after this sec... | {
"source": "github-docs/rest/enterprise-admin/ldap.md",
"title": "REST API endpoints for LDAP"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/licensing.md",
"title": "Licensing"
} |
About the Manage API
You can manage using the Manage API. For example, you can retrieve information about the version of the software running on the instance, or on instances with multiple nodes, view the status of replication.
[!TIP] You can use this API to replace the functionality of the Management Console API,... | {
"source": "github-docs/rest/enterprise-admin/manage-ghes.md",
"title": "REST API endpoints for managing GitHub Enterprise Server"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/network-configurations.md",
"title": "REST API endpoints for enterprise network configurations"
} |
About organization pre-receive hooks
Object attributes
Name Type Description
--------------------------------------------------------------------------------------------------------
name string The name of ... | {
"source": "github-docs/rest/enterprise-admin/org-pre-receive-hooks.md",
"title": "REST API endpoints for organization pre-receive hooks"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/organization-installations.md",
"title": "REST API for managing organization GitHub App installations"
} |
About organization administration
These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/orgs.md",
"title": "REST API endpoints for enterprise organizations"
} |
About pre-receive environments
These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.
Object attributes
Pre-receive Environment
Name Type Description
-------------------... | {
"source": "github-docs/rest/enterprise-admin/pre-receive-environments.md",
"title": "REST API endpoints for pre-receive environments"
} |
About pre-receive hooks
These endpoints are only available to authenticated site administrators. Normal users will receive a 404 response.
Object attributes
Pre-receive Hook
Name Type Description
---------------------------------... | {
"source": "github-docs/rest/enterprise-admin/pre-receive-hooks.md",
"title": "REST API endpoints for pre-receive hooks"
} |
About repository pre-receive hooks
Name Type Description
------------------------------------------------------------------------------------------
name string The name of the hook.
enforcement ... | {
"source": "github-docs/rest/enterprise-admin/repo-pre-receive-hooks.md",
"title": "REST API endpoints for repository pre-receive hooks"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/rules.md",
"title": "REST API endpoints for rules"
} |
[!NOTE]
About SCIM
If you don't use a partner IdP with an existing integration, you can integrate using the following API endpoints. For more information, see AUTOTITLE.
Base URL
To manage your enterprise's users and groups using SCIM, use the following base URL to communicate with the endpoints in this category.
{%... | {
"source": "github-docs/rest/enterprise-admin/scim.md",
"title": "REST API endpoints for SCIM"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/security-advisories.md",
"title": "REST API endpoints for security advisories"
} |
About user administration
These endpoints are only available to authenticated site administrators. Normal users will receive a 403 response.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-admin/users.md",
"title": "REST API endpoints for enterprise users"
} |
About enterprise team members
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-teams/enterprise-team-members.md",
"title": "REST API endpoints for enterprise team memberships"
} |
About enterprise team organizations
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-teams/enterprise-team-organizations.md",
"title": "REST API endpoints for enterprise team organizations"
} |
About enterprise teams
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/enterprise-teams/enterprise-teams.md",
"title": "REST API endpoints for enterprise teams"
} |
About gist comments
You can use the REST API to view and modify comments on a gist. For more information about gists, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/gists/comments.md",
"title": "REST API endpoints for gist comments"
} |
About gists
You can use the REST API to view and modify gists. For more information about gists, see AUTOTITLE.
[!NOTE] Gists are not available with .
Authentication
You can read public gists and create them for anonymous users without a token. anonymously, but you must be signed into to create gists. To read or wri... | {
"source": "github-docs/rest/gists/gists.md",
"title": "REST API endpoints for gists"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/gists/index.md",
"title": "REST API endpoints for gists and gist comments"
} |
About Git blobs
A Git blob (binary large object) is the object type used to store the contents of each file in a repository. The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write blob objects
to your Git database on . Blobs leverage custom media types. For more inf... | {
"source": "github-docs/rest/git/blobs.md",
"title": "REST API endpoints for Git blobs"
} |
About Git commits
A Git commit is a snapshot of the hierarchy (Git tree) and the contents of the files (Git blob) in a Git repository. These endpoints allow you to read and write commit objects to your Git database on .
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/git/commits.md",
"title": "REST API endpoints for Git commits"
} |
About Git database
The REST API gives you access to read and write raw Git objects to your Git database on and to list and update your references (branch heads and tags). For more information about using the REST API to interact with your Git database, see AUTOTITLE.
<!-- Content after this section is automatically ge... | {
"source": "github-docs/rest/git/index.md",
"title": "REST API endpoints for Git database"
} |
About Git references
A Git reference (git ref) is a file that contains a Git commit SHA-1 hash. When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is a Git reference that stores the... | {
"source": "github-docs/rest/git/refs.md",
"title": "REST API endpoints for Git references"
} |
About Git tags
A Git tag is similar to a Git reference, but the Git commit that it points to never changes. Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write tag objects to your Git database on . The API only supports annotated tag objects, not lightweight tag... | {
"source": "github-docs/rest/git/tags.md",
"title": "REST API endpoints for Git tags"
} |
About Git trees
A Git tree object creates the hierarchy between files in a Git repository. You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write tree objects to your Git database on .
<!-- Content after this section is auto... | {
"source": "github-docs/rest/git/trees.md",
"title": "REST API endpoints for Git trees"
} |
About gitignore
When you create a new repository on via the API, you can specify a .gitignore template to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the .gitignore repository.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/gitignore/gitignore.md",
"title": "REST API endpoints for gitignore"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/gitignore/index.md",
"title": "REST API endpoints for gitignore"
} |
You can use the REST API to tie together commits with
a testing service, so that every push you make can be tested and represented
in a pull request. For more information about the relevant endpoints, see AUTOTITLE.
This guide will use that API to demonstrate a setup that you can use.
In our scenario, we will:
Run ou... | {
"source": "github-docs/rest/guides/building-a-ci-server.md",
"title": "Building a CI server"
} |
You can use the REST API to deploy your projects hosted on on a server that you own. For more information about the endpoints to manage deployments and statuses, see AUTOTITLE. You can also use the REST API to coordinate your deployments the moment your code lands on the default branch. For more information, see AUTOT... | {
"source": "github-docs/rest/guides/delivering-deployments.md",
"title": "Delivering deployments"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.