1
0
mirror of synced 2025-12-23 21:07:12 -05:00

Update OpenAPI Description (#56550)

Co-authored-by: Vanessa <vgrl@github.com>
This commit is contained in:
docs-bot
2025-07-09 14:44:42 -07:00
committed by GitHub
parent fb6844eef0
commit d0ab658987
3 changed files with 344 additions and 344 deletions

View File

@@ -4662,13 +4662,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the <code>manage_runners:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": "<p>Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the <code>manage_runners:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -4918,13 +4918,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get the list of partner images available for GitHub-hosted runners for an organization.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get the list of partner images available for GitHub-hosted runners for an organization.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -5129,13 +5129,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get the list of machine specs available for GitHub-hosted runners for an organization.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get the list of machine specs available for GitHub-hosted runners for an organization.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -5209,13 +5209,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get the list of platforms available for GitHub-hosted runners for an organization.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get the list of platforms available for GitHub-hosted runners for an organization.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -6138,13 +6138,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a GitHub-hosted runner for an organization.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
"description": "<p>Accepted</p>"
}
]
],
"descriptionHTML": "<p>Deletes a GitHub-hosted runner for an organization.</p>"
}
],
"oidc": [
@@ -6670,13 +6670,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -7016,13 +7016,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -7215,13 +7215,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -7535,13 +7535,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -7618,13 +7618,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -12989,13 +12989,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -13937,13 +13937,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -13997,13 +13997,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -15658,13 +15658,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -16080,13 +16080,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the GitHub-hosted runners in an organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists the GitHub-hosted runners in an organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -18341,13 +18341,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -21882,13 +21882,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists all self-hosted runners configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -24370,13 +24370,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an organization. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an organization. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -29442,13 +29442,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Response when creating a variable</p>"
}
]
],
"descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -48649,13 +48649,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>\n<p>This endpoint will return up to 1,000 results for each search when using the following parameters: <code>actor</code>, <code>branch</code>, <code>check_suite_id</code>, <code>created</code>, <code>event</code>, <code>head_sha</code>, <code>status</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>\n<p>This endpoint will return up to 1,000 results for each search when using the following parameters: <code>actor</code>, <code>branch</code>, <code>check_suite_id</code>, <code>created</code>, <code>event</code>, <code>head_sha</code>, <code>status</code>.</p>"
}
],
"workflows": [
@@ -96669,13 +96669,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes the announcement banner currently set for the enterprise.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Removes the announcement banner currently set for the enterprise.</p>"
}
],
"organizations": [
@@ -97445,13 +97445,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the <code>installations_count</code> in the response. For more details about your app's installations, see the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app\">List installations for the authenticated app</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the <code>installations_count</code> in the response. For more details about your app's installations, see the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app\">List installations for the authenticated app</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -138617,13 +138617,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -139516,7 +139516,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists who has access to this protected branch.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nUsers, apps, and teams <code>restrictions</code> are only available for organization-owned repositories.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -139526,7 +139525,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists who has access to this protected branch.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nUsers, apps, and teams <code>restrictions</code> are only available for organization-owned repositories.</p>\n</div>"
},
{
"serverUrl": "https://api.github.com",
@@ -143583,7 +143583,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Grants the specified people push access for this branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>Usernames for people who can have push access. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -143593,7 +143592,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
],
"descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Grants the specified people push access for this branch.</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>array</code></td><td>Usernames for people who can have push access. <strong>Note</strong>: The list of users, apps, and teams in total is limited to 100 items.</td></tr></tbody></table>"
},
{
"serverUrl": "https://api.github.com",
@@ -153016,13 +153016,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists annotations for a check run using the annotation <code>id</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists annotations for a check run using the annotation <code>id</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -267190,7 +267190,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -267200,7 +267199,8 @@
"httpStatusCode": "204",
"description": "<p>Response when updating a secret</p>"
}
]
],
"descriptionHTML": "<p>Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -270552,13 +270552,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>"
}
]
},
@@ -283909,13 +283909,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes an existing audit log stream configuration for an enterprise.</p>\n<p>When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"<a href=\"/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>The audit log stream configuration was deleted successfully.</p>"
}
]
],
"descriptionHTML": "<p>Deletes an existing audit log stream configuration for an enterprise.</p>\n<p>When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"<a href=\"/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>"
}
],
"billing": [
@@ -288170,13 +288170,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates a hosted compute network configuration for an enterprise.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": "<p>Creates a hosted compute network configuration for an enterprise.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -288455,13 +288455,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a hosted compute network configuration for an enterprise.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Updates a hosted compute network configuration for an enterprise.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -288631,13 +288631,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a hosted compute network settings resource configured for an enterprise.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets a hosted compute network settings resource configured for an enterprise.</p>"
}
],
"organization-installations": [
@@ -288749,13 +288749,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.</p>\n<p>This API can only be called by a GitHub App installed on the enterprise that owns the organization.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>A list of organizations owned by the enterprise on which the authenticated GitHub App is installed.</p>"
}
]
],
"descriptionHTML": "<p>List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.</p>\n<p>This API can only be called by a GitHub App installed on the enterprise that owns the organization.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -290576,7 +290576,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Installs any valid GitHub App on the specified organization owned by the enterprise. If the app is already installed on the organization, and is suspended, it will be unsuspended.\nIf the app has a pending installation request, they will all be approved.</p>\n<p>If the app is already installed and has a pending update request, it will be updated to the latest version. If the app is now requesting repository permissions, it will be given access to the repositories listed in the request or fail if no <code>repository_selection</code> is provided.</p>\n<p>This API can only be called by a GitHub App installed on the enterprise that owns the organization.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -290586,7 +290585,8 @@
"httpStatusCode": "201",
"description": "<p>A GitHub App installation.</p>"
}
]
],
"descriptionHTML": "<p>Installs any valid GitHub App on the specified organization owned by the enterprise. If the app is already installed on the organization, and is suspended, it will be unsuspended.\nIf the app has a pending installation request, they will all be approved.</p>\n<p>If the app is already installed and has a pending update request, it will be updated to the latest version. If the app is now requesting repository permissions, it will be given access to the repositories listed in the request or fail if no <code>repository_selection</code> is provided.</p>\n<p>This API can only be called by a GitHub App installed on the enterprise that owns the organization.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -411264,7 +411264,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>You must send Markdown as plain text (using a <code>Content-Type</code> header of <code>text/plain</code> or <code>text/x-markdown</code>) to this endpoint, rather than using JSON format. In raw mode, <a href=\"https://github.github.com/gfm/\">GitHub Flavored Markdown</a> is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -411274,7 +411273,8 @@
"httpStatusCode": "304",
"description": "<p>Not modified</p>"
}
]
],
"descriptionHTML": "<p>You must send Markdown as plain text (using a <code>Content-Type</code> header of <code>text/plain</code> or <code>text/x-markdown</code>) to this endpoint, rather than using JSON format. In raw mode, <a href=\"https://github.github.com/gfm/\">GitHub Flavored Markdown</a> is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.</p>"
}
]
},
@@ -427545,7 +427545,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all organizations, in the order that they were created.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPagination is powered exclusively by the <code>since</code> parameter. Use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a> to get the URL for the next page of organizations.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -427555,7 +427554,8 @@
"httpStatusCode": "304",
"description": "<p>Not modified</p>"
}
]
],
"descriptionHTML": "<p>Lists all organizations, in the order that they were created.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPagination is powered exclusively by the <code>since</code> parameter. Use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a> to get the URL for the next page of organizations.</p>\n</div>"
},
{
"serverUrl": "https://api.github.com",
@@ -430020,13 +430020,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the audit log for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization\">Reviewing the audit log for your organization</a>.\"</p>\n<p>By default, the response includes up to 30 events from the past three months. Use the <code>phrase</code> parameter to filter results and retrieve older events. For example, use the <code>phrase</code> parameter with the <code>created</code> qualifier to filter events based on when the events occurred. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log\">Reviewing the audit log for your organization</a>.\"</p>\n<p>Use pagination to retrieve fewer or more than 30 events. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>\n<p>This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api\">Rate limits for the REST API</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators\">Best practices for integrators</a>.\"</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:audit_log</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets the audit log for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization\">Reviewing the audit log for your organization</a>.\"</p>\n<p>By default, the response includes up to 30 events from the past three months. Use the <code>phrase</code> parameter to filter results and retrieve older events. For example, use the <code>phrase</code> parameter with the <code>created</code> qualifier to filter events based on when the events occurred. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log\">Reviewing the audit log for your organization</a>.\"</p>\n<p>Use pagination to retrieve fewer or more than 30 events. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>\n<p>This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api\">Rate limits for the REST API</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators\">Best practices for integrators</a>.\"</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:audit_log</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -431441,13 +431441,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -432313,13 +432313,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -432767,13 +432767,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get the number of API requests and rate-limited requests made within an organization over a specified time period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get the number of API requests and rate-limited requests made within an organization over a specified time period.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -432912,13 +432912,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -433911,7 +433911,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -433921,7 +433920,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
],
"descriptionHTML": "<p>Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -434614,7 +434614,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets all custom properties defined for an organization.\nOrganization members can read these properties.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -434628,7 +434627,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Gets all custom properties defined for an organization.\nOrganization members can read these properties.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -438949,7 +438949,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -438959,7 +438958,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -442810,13 +442810,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -445502,7 +445502,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the organization roles available in this organization. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>read_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -445516,7 +445515,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
],
"descriptionHTML": "<p>Lists the organization roles available in this organization. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>read_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -447147,13 +447147,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -480475,7 +480475,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -480485,7 +480484,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -510710,13 +510710,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Edits the content of a specified review comment.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Edits the content of a specified review comment.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
},
{
"serverUrl": "https://api.github.com",
@@ -580457,13 +580457,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a redirect URL to download a tar archive for a repository. If you omit <code>:ref</code>, the repositorys default branch (usually\n<code>main</code>) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe <code>Location</code> header to make a second <code>GET</code> request.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nFor private repositories, these links are temporary and expire after five minutes.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "302",
"description": "<p>Found</p>"
}
]
],
"descriptionHTML": "<p>Gets a redirect URL to download a tar archive for a repository. If you omit <code>:ref</code>, the repositorys default branch (usually\n<code>main</code>) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe <code>Location</code> header to make a second <code>GET</code> request.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nFor private repositories, these links are temporary and expire after five minutes.</p>\n</div>"
},
{
"serverUrl": "https://api.github.com",
@@ -609124,7 +609124,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -609134,7 +609133,8 @@
"httpStatusCode": "304",
"description": "<p>Not modified</p>"
}
]
],
"descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>"
},
{
"serverUrl": "https://api.github.com",
@@ -674426,13 +674426,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.</p>\n<p>The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the <code>attestations:read</code> permission is required.</p>\n<p><strong>Please note:</strong> in order to offer meaningful security benefits, an attestation's signature and timestamps <strong>must</strong> be cryptographically verified, and the identity of the attestation signer <strong>must</strong> be validated. Attestations can be verified using the <a href=\"https://cli.github.com/manual/gh_attestation_verify\">GitHub CLI <code>attestation verify</code> command</a>. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds\">our guide on how to use artifact attestations to establish a build's provenance</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.</p>\n<p>The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the <code>attestations:read</code> permission is required.</p>\n<p><strong>Please note:</strong> in order to offer meaningful security benefits, an attestation's signature and timestamps <strong>must</strong> be cryptographically verified, and the identity of the attestation signer <strong>must</strong> be validated. Attestations can be verified using the <a href=\"https://cli.github.com/manual/gh_attestation_verify\">GitHub CLI <code>attestation verify</code> command</a>. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds\">our guide on how to use artifact attestations to establish a build's provenance</a>.</p>"
},
{
"serverUrl": "https://api.github.com",

File diff suppressed because it is too large Load Diff

View File

@@ -5287,13 +5287,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> repository permission to use this API.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> repository permission to use this API.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5818,13 +5818,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -8360,6 +8360,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -8369,8 +8370,7 @@
"httpStatusCode": "204",
"description": "<p>Response when updating a secret</p>"
}
],
"descriptionHTML": "<p>Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10461,13 +10461,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -12871,13 +12871,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
],
"descriptionHTML": "<p>Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -23692,13 +23692,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in a repository.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in a repository.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26896,13 +26896,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific variable in a repository.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Gets a specific variable in a repository.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -28141,13 +28141,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific job in a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Gets a specific job in a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -40258,13 +40258,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Approve or reject pending deployments that are waiting on approval by a required reviewer.</p>\n<p>Required reviewers with read access to the repository contents and deployments can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Approve or reject pending deployments that are waiting on approval by a required reviewer.</p>\n<p>Required reviewers with read access to the repository contents and deployments can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -88351,13 +88351,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the people watching the specified repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Lists the people watching the specified repository.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -103635,13 +103635,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
],
"descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -192956,13 +192956,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": ""
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -199259,13 +199259,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>Default response</p>"
}
],
"descriptionHTML": "<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
]
}
],
"protection-rules": [
@@ -205605,13 +205605,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -206998,13 +206998,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": ""
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -207172,13 +207172,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
],
"descriptionHTML": ""
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -207515,13 +207515,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
],
"descriptionHTML": ""
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -208363,13 +208363,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": ""
]
}
],
"manage-ghes": [
@@ -212259,6 +212259,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you attempt to delete an environment that cannot be deleted, you will receive a <code>422 Unprocessable Entity</code> response.</p>\n<p>The possible error messages are:</p>\n<ul>\n<li><em>Cannot modify or delete the default environment</em></li>\n<li><em>Cannot delete environment that has hooks</em></li>\n<li><em>Cannot delete environment when download is in progress</em></li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -212268,8 +212269,7 @@
"httpStatusCode": "422",
"description": "<p>Client Errors</p>"
}
],
"descriptionHTML": "<p>If you attempt to delete an environment that cannot be deleted, you will receive a <code>422 Unprocessable Entity</code> response.</p>\n<p>The possible error messages are:</p>\n<ul>\n<li><em>Cannot modify or delete the default environment</em></li>\n<li><em>Cannot delete environment that has hooks</em></li>\n<li><em>Cannot delete environment when download is in progress</em></li>\n</ul>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -213639,13 +213639,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>For pre-receive hooks which are allowed to be configured at the repo level, you can set <code>enforcement</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>For pre-receive hooks which are allowed to be configured at the repo level, you can set <code>enforcement</code></p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -222920,13 +222920,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
],
"descriptionHTML": ""
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -223081,13 +223081,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>If your GitHub instance uses <a href=\"https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap\">LDAP Sync with Active Directory LDAP servers</a>, 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 <code>403</code> response.</p>\n<p>You can suspend any user account except your own.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
],
"descriptionHTML": "<p>If your GitHub instance uses <a href=\"https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap\">LDAP Sync with Active Directory LDAP servers</a>, 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 <code>403</code> response.</p>\n<p>You can suspend any user account except your own.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -296258,13 +296258,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a label using the given label name.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Updates a label using the given label name.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -316623,13 +316623,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -316866,13 +316866,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get the octocat as ASCII art</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Get the octocat as ASCII art</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -339729,13 +339729,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -347802,13 +347802,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes an organization role from a team. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
],
"descriptionHTML": "<p>Removes an organization role from a team. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -348022,13 +348022,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
],
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -410221,13 +410221,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -530930,13 +530930,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>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.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>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.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -539218,13 +539218,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the people following the specified user.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
],
"descriptionHTML": "<p>Lists the people following the specified user.</p>"
]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",