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.
Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org 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.
Gets a specific variable in an environment.
\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.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific variable in an environment.
\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.
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.
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.
Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\nLocation: 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 an archive of log files for a workflow run. This link expires after 1 minute. Look for\nLocation: 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.
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.
Lists the people watching the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists the people watching the specified repository.
" }, { "serverUrl": "https://api.github.com", @@ -85565,13 +85565,13 @@ } ], "previews": [], - "descriptionHTML": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.
" }, { "serverUrl": "https://api.github.com", @@ -96793,13 +96793,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": "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.
Gets an organization development environment 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 an organization development environment secret without revealing its encrypted value.
\nOAuth 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.
" } ] }, @@ -257381,6 +257381,7 @@ } ], "previews": [], + "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.
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.
Lists the deployment branch policies 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": "Lists the deployment branch policies 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.
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.
" + ] } ] }, @@ -388847,13 +388847,13 @@ } ], "previews": [], - "descriptionHTML": "This endpoint allows you to run an inference request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the messages for the chat completion request. The response will include either a non-streaming or streaming response based on the request parameters.
OK
" } - ] + ], + "descriptionHTML": "This endpoint allows you to run an inference request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the messages for the chat completion request. The response will include either a non-streaming or streaming response based on the request parameters.
The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.
Resource not found
" } - ] + ], + "descriptionHTML": "The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.
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.
Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read: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.
\nUpdates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ] + ], + "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
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.\"
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.\"
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion 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,6 +94477,7 @@ } ], "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", @@ -94486,8 +94487,7 @@ "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,6 +175661,7 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", @@ -175670,8 +175671,7 @@ "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.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 59fee11f1c15..983d348a1ddd 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -4802,13 +4802,13 @@ } ], "previews": [], - "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.
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.
Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\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 repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\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.
Updates the name and visibility of a self-hosted runner group in an enterprise.
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Updates the name and visibility of a self-hosted runner group in an enterprise.
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise 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 a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner group for an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
Example using remove token:
\nTo remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.
\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 to remove a self-hosted runner from an organization. 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 remove your self-hosted runner from an organization:
./config.sh remove --token TOKEN\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 to remove a self-hosted runner from an organization. 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 remove your self-hosted runner from an organization:
./config.sh remove --token TOKEN\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 job in a workflow run.
\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": "Gets a specific job in a workflow run.
\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.
Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nOK
" } - ] + ], + "descriptionHTML": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\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", @@ -90962,13 +90962,13 @@ } ], "previews": [], - "descriptionHTML": "Sets the announcement banner to display for the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Sets the announcement banner to display for the organization.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -100212,13 +100212,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", @@ -196181,13 +196181,13 @@ } ], "previews": [], - "descriptionHTML": "Lists the deployment branch policies 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": "Lists the deployment branch policies 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.
Updates 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": "Updates 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", @@ -205073,13 +205073,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205722,13 +205722,13 @@ } ], "previews": [], - "descriptionHTML": "Gets the current message and expiration date of the global announcement banner in your enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Gets the current message and expiration date of the global announcement banner in your enterprise.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209041,7 +209041,6 @@ } ], "previews": [], - "descriptionHTML": "Triggers a run of ghe-config-apply from the ghes-manage agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.
Unauthorized
" } - ] + ], + "descriptionHTML": "Triggers a run of ghe-config-apply from the ghes-manage agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -213606,13 +213606,13 @@ } ], "previews": [], - "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
OK
" } - ] + ], + "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -316829,13 +316829,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", @@ -322269,7 +322269,6 @@ } ], "previews": [], - "descriptionHTML": "Fetches the URL to a migration archive.
", "statusCodes": [ { "httpStatusCode": "302", @@ -322279,7 +322278,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Fetches the URL to a migration archive.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -344916,13 +344916,13 @@ } ], "previews": [], - "descriptionHTML": "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", @@ -347689,13 +347689,13 @@ } ], "previews": [], - "descriptionHTML": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Returns a delivery for a webhook configured in an organization.
\nYou must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Returns a delivery for a webhook configured in an organization.
\nYou must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Lists package versions for a package owned by 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.\"
Resource not found
" } - ] + ], + "descriptionHTML": "Lists package versions for a package owned by 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.\"
Gets a specific package for a package owned by the authenticated user.
\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 for a package owned by the authenticated user.
\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.\"
List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -428261,7 +428260,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "List the reactions to a commit comment.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -431146,13 +431146,13 @@ } ], "previews": [], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -457825,13 +457825,13 @@ } ], "previews": [], - "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -525970,13 +525970,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.