From c126b9427681f54db00b76e7f206a59b7f6e0dec Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Sun, 8 Jun 2025 05:06:19 -0700 Subject: [PATCH] Update OpenAPI Description (#55974) --- src/rest/data/fpt-2022-11-28/schema.json | 76 ++-- .../data/ghes-3.13-2022-11-28/schema.json | 80 ++-- .../data/ghes-3.16-2022-11-28/schema.json | 344 +++++++++--------- 3 files changed, 250 insertions(+), 250 deletions(-) diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index afbbbffbc71b..6020c8036548 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -1659,13 +1659,13 @@ } ], "previews": [], - "descriptionHTML": "
Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets a single organization secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Updates a repository variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Deletes an environment variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes an environment variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must configure your GitHub Actions workflow to run when the workflow_dispatch
webhook event occurs. The inputs
are configured in the workflow file. For more information about how to configure the workflow_dispatch
event in the workflow file, see \"Events that trigger workflows.\"
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must configure your GitHub Actions workflow to run when the workflow_dispatch
webhook event occurs. The inputs
are configured in the workflow file. For more information about how to configure the workflow_dispatch
event in the workflow file, see \"Events that trigger workflows.\"
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
" }, { "serverUrl": "https://api.github.com", @@ -109150,13 +109150,13 @@ } ], "previews": [], - "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the user
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the user
scope to use this endpoint.
If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.
\nTo set a deployment as inactive, you must:
\nFor more information, see \"Create a deployment\" and \"Create a deployment status.\"
\nOAuth app tokens and personal access tokens (classic) need the repo
or repo_deployment
scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.
\nTo set a deployment as inactive, you must:
\nFor more information, see \"Create a deployment\" and \"Create a deployment status.\"
\nOAuth app tokens and personal access tokens (classic) need the repo
or repo_deployment
scope to use this endpoint.
Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug}
endpoint.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
List of deployment protection rules
" } - ] + ], + "descriptionHTML": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug}
endpoint.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
Removes any interaction restrictions from your public repositories.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Removes any interaction restrictions from your public repositories.
" } ] }, @@ -398775,7 +398775,6 @@ } ], "previews": [], - "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state
parameter in the response can be used to identify the user's membership status.
Resource not found
" } - ] + ], + "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state
parameter in the response can be used to identify the user's membership status.
Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
" }, { "serverUrl": "https://api.github.com", @@ -401368,13 +401368,13 @@ } ], "previews": [], - "descriptionHTML": "Lists all hosted compute network configurations configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all hosted compute network configurations configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations
scope to use this endpoint.
Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations
scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations
scope to use this endpoint.
Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nOK
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nRestores an entire package in an organization.
\nYou can restore a deleted package under the following conditions:
\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the package_type
belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"
OAuth app tokens and personal access tokens (classic) need the read:packages
and write:packages
scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Resource not found
" } - ] + ], + "descriptionHTML": "Restores an entire package in an organization.
\nYou can restore a deleted package under the following conditions:
\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the package_type
belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"
OAuth app tokens and personal access tokens (classic) need the read:packages
and write:packages
scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Returns the webhook configuration for a repository. To get more information about the webhook, including the active
state and events
, use \"Get a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the read:repo_hook
or repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Returns the webhook configuration for a repository. To get more information about the webhook, including the active
state and events
, use \"Get a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the read:repo_hook
or repo
scope to use this endpoint.
Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all self-hosted runners configured for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Gets a specific self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count
in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count
in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -93396,13 +93396,13 @@ } ], "previews": [], - "descriptionHTML": "The permissions the installation has are included under the permissions
key.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The permissions the installation has are included under the permissions
key.
The permissions the installation has are included under the permissions
key.
You must use a JWT to access this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -94477,7 +94477,6 @@ } ], "previews": [], - "descriptionHTML": "Enables an authenticated GitHub App to find an installation's information using the installation id.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -94487,7 +94486,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Enables an authenticated GitHub App to find an installation's information using the installation id.
\nYou must use a JWT to access this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -123586,13 +123586,13 @@ } ], "previews": [], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -175661,7 +175661,6 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", @@ -175671,7 +175670,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -186879,13 +186879,13 @@ } ], "previews": [], - "descriptionHTML": "Lists all repositories that have been selected when the visibility
\nfor 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.
OK
" } - ] + ], + "descriptionHTML": "Lists all repositories that have been selected when the visibility
\nfor 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.
Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "Gets a deployment branch or tag policy for an environment.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201647,13 +201647,13 @@ } ], "previews": [], - "descriptionHTML": "Removes the global announcement banner in your enterprise.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Removes the global announcement banner in your enterprise.
" } ], "audit-log": [ @@ -202726,13 +202726,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -216539,13 +216539,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -507187,13 +507187,13 @@ } ], "previews": [], - "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
For more information about the permission levels, see \"Repository permission levels for an organization\".
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index df9fa4f3e37e..582c06027a19 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -264,13 +264,13 @@ } ], "previews": [], + "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets the GitHub Actions cache usage policy for an enterprise.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the GitHub Actions cache usage policy for an enterprise.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
A JSON serialized template for OIDC subject claim customization
" } - ], - "descriptionHTML": "Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
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.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "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.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
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.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "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.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions
to selected
actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions
to selected
actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected
actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.
To use the patterns_allowed
setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected
actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.
To use the patterns_allowed
setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single repository secret without revealing its encrypted value.
\nThe authenticated user must have collaborator access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Creates a new self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an organization runner group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces the list of self-hosted runners that are part of an organization runner group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Returns a token that you can pass to the config
script. The token expires after one hour.
For example, you can replace TOKEN
in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\n
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config
script. The token expires after one hour.
For example, you can replace TOKEN
in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\n
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
OK
" } - ], - "descriptionHTML": "Gets a specific self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
Lists all labels for a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
Resource not found
" } - ], - "descriptionHTML": "Lists all labels for a self-hosted runner configured in an organization.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
Resource not found
" } - ], - "descriptionHTML": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\nOAuth 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.
Lists binaries for the runner application that you can download and run.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists binaries for the runner application that you can download and run.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth 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.
OK
" } - ], - "descriptionHTML": "Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth 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.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Response when creating a variable
" } - ], - "descriptionHTML": "Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need theadmin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Lists all repository variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all repository variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Updates a repository variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Lists all environment variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all environment variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Updates an environment variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location:
in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Found
" } - ], - "descriptionHTML": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location:
in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Re-runs your workflow run using its id
.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Re-runs your workflow run using its id
.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nMarks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No content
" } - ], - "descriptionHTML": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -100270,13 +100270,13 @@ } ], "previews": [], + "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -108425,6 +108425,7 @@ } ], "previews": [], + "descriptionHTML": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
", "statusCodes": [ { "httpStatusCode": "204", @@ -108434,8 +108435,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
" + ] } ], "webhooks": [ @@ -109398,13 +109398,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the GitHub Advanced Security active committers for an organization per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers
is not the sum of advanced_security_committers for each repository.
If this organization defers to an enterprise for billing, the total_advanced_security_committers
returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
The total number of repositories with committer information is tracked by the total_count
field.
Success
" } - ], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an organization per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers
is not the sum of advanced_security_committers for each repository.
If this organization defers to an enterprise for billing, the total_advanced_security_committers
returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
The total number of repositories with committer information is tracked by the total_count
field.
Creates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org
scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nSuccessfully created code security configuration
" } - ], - "descriptionHTML": "Creates a code security configuration in an organization.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org
scope to use this endpoint.
Note
\n\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.
\nSets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org
scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nResource not found
" } - ], - "descriptionHTML": "Sets a code security configuration as a default to be applied to new repositories in your organization.
\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org
scope to use this endpoint.
Note
\n\nThe enablement status will only be returned for installed security products.
\nOK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -193731,13 +193731,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Replaces all repositories for an organization secret when the visibility
\nfor repository access is set to selected
. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces all repositories for an organization secret when the visibility
\nfor repository access is set to selected
. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
" + ] } ] }, @@ -200691,13 +200691,13 @@ } ], "previews": [], + "descriptionHTML": "Deletes a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209748,13 +209748,13 @@ } ], "previews": [], + "descriptionHTML": "Removes the global announcement banner in your enterprise.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Removes the global announcement banner in your enterprise.
" + ] } ], "audit-log": [ @@ -216535,13 +216535,13 @@ } ], "previews": [], + "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
" + ] } ], "orgs": [ @@ -218578,13 +218578,13 @@ } ], "previews": [], + "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -218676,13 +218676,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -228279,13 +228279,13 @@ } ], "previews": [], + "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403
response.
You can suspend any user account except your own.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
No Content
" } - ], - "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403
response.
You can suspend any user account except your own.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Deletes a label using the given label name.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Deletes a label using the given label name.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -321817,13 +321817,13 @@ } ], "previews": [], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -322060,13 +322060,13 @@ } ], "previews": [], + "descriptionHTML": "Get the octocat as ASCII art
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the octocat as ASCII art
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -346275,6 +346275,7 @@ } ], "previews": [], + "descriptionHTML": "Creates a new or updates an existing custom property that is defined for an organization.
\nTo use this endpoint, the authenticated user must be one of:
\ncustom_properties_org_definitions_manager
in the organization.Resource not found
" } - ], - "descriptionHTML": "Creates a new or updates an existing custom property that is defined for an organization.
\nTo use this endpoint, the authenticated user must be one of:
\ncustom_properties_org_definitions_manager
in the organization.Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
Only authenticated organization owners can add a member to the organization or update the member's role. If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending
until they accept the invitation. Authenticated users can update a user's membership by passing the role
parameter. If the authenticated user changes a member's role to admin
, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member
, no email will be sent. The same rate limits as set on the appliance are applied to this endpoint. Most commonly, you will hit the secondary rate limit (if configured) due to CPU usage.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role. If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending
until they accept the invitation. Authenticated users can update a user's membership by passing the role
parameter. If the authenticated user changes a member's role to admin
, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member
, no email will be sent. The same rate limits as set on the appliance are applied to this endpoint. Most commonly, you will hit the secondary rate limit (if configured) due to CPU usage.
Members of an organization can choose to have their membership publicized or not.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -350442,13 +350442,13 @@ } ], "previews": [], + "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -355005,13 +355005,13 @@ } ], "previews": [], + "descriptionHTML": "List all users who are outside collaborators of an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "List all users who are outside collaborators of an organization.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -366505,13 +366505,13 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nOK
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nGets a specific package in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages
scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages
scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Lists builts of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists builts of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ], - "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -414174,13 +414174,13 @@ } ], "previews": [], + "descriptionHTML": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.OK
" } - ], - "descriptionHTML": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.The list of reviews returns in chronological order.
" } - ], - "descriptionHTML": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Note
\n\nYou can also specify a team or organization with team_id
and org_id
using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id
.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a team or organization with team_id
and org_id
using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id
.
Delete a reaction to a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -437737,8 +437738,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List the reactions to a pull request review comment.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -443340,13 +443340,13 @@ } ], "previews": [], + "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at
attribute. The created_at
attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
OK
" } - ], - "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at
attribute. The created_at
attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "https://HOSTNAME/api/uploads", @@ -491240,13 +491240,13 @@ } ], "previews": [], + "descriptionHTML": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -499026,6 +499026,7 @@ } ], "previews": [], + "descriptionHTML": "Repositories can have multiple webhooks installed. Each webhook should have a unique config
. Multiple webhooks can\nshare the same config
as long as those webhooks do not have any events
that overlap.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Repositories can have multiple webhooks installed. Each webhook should have a unique config
. Multiple webhooks can\nshare the same config
as long as those webhooks do not have any events
that overlap.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nOK
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length
to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Note
\n\nYou can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
For more information about the permission levels, see \"Repository permission levels for an organization\".
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -530840,13 +530840,13 @@ } ], "previews": [], + "descriptionHTML": "List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments
.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "List all comments on a team discussion.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments
.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Edits the body text of a discussion comment.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a comment on a team discussion.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -538599,13 +538599,13 @@ } ], "previews": [], + "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -538833,13 +538833,13 @@ } ], "previews": [], + "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -546870,13 +546870,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the people who the specified user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the people who the specified user follows.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3",