--- openapi: 3.0.3 info: version: 1.1.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: name: MIT url: https://spdx.org/licenses/MIT termsOfService: https://docs.github.com/articles/github-terms-of-service contact: name: Support url: https://support.github.com/contact?tags=dotcom-rest-api x-github-plan: ghec tags: - name: actions description: Endpoints to manage GitHub Actions using the REST API. - name: activity description: Activity APIs provide access to notifications, subscriptions, and timelines. - name: apps description: Information for integrations and installations. - name: billing description: Monitor charges and usage from Actions and Packages. - name: checks description: Rich interactions with checks run by your integrations. - name: code-scanning description: Retrieve code scanning alerts from a repository. - name: codes-of-conduct description: Insight into codes of conduct for your communities. - name: emojis description: List emojis available to use on GitHub. - name: dependabot description: Endpoints to manage Dependabot. - name: dependency-graph description: Endpoints to access Dependency Graph features. - name: gists description: View, modify your gists. - name: git description: Raw Git functionality. - name: gitignore description: View gitignore templates - name: issues description: Interact with GitHub Issues. - name: licenses description: View various OSS licenses. - name: markdown description: Render GitHub flavored Markdown - name: merge-queue description: Interact with GitHub Merge Queues. - name: meta description: Endpoints that give information about the API. - name: migrations description: Move projects to or from GitHub. - name: oidc description: Endpoints to manage GitHub OIDC configuration using the REST API. - name: orgs description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. - name: projects-classic description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit description: Check your current rate limit status. - name: reactions description: Interact with reactions to various GitHub entities. - name: repos description: Interact with GitHub Repos. - name: search description: Search for specific items on GitHub. - name: secret-scanning description: Retrieve secret scanning alerts from a repository. - name: teams description: Interact with GitHub Teams. - name: users description: Interact with and view information about users and also current user. - name: codespaces description: Endpoints to manage Codespaces using the REST API. - name: copilot description: Endpoints to manage Copilot using the REST API. - name: enterprise-admin description: Enterprise Administration - name: scim description: Provisioning of GitHub organization membership for SCIM-enabled providers. - name: server-statistics description: Server statistics - name: security-advisories description: Manage security advisories. - name: interactions description: Owner or admin management of users interactions. - name: classroom description: Interact with GitHub Classroom. - name: desktop description: Desktop specific endpoints. - name: dsr description: Endpoints to manage DSR operations. - name: enterprise-teams description: Endpoints to manage GitHub Enterprise Teams. - name: enterprise-team-memberships description: Endpoints to manage GitHub Enterprise Team memberships. - name: enterprise-team-organizations description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries description: Manage private registry configurations. - name: hosted-compute description: Manage hosted compute networking resources. - name: campaigns description: Endpoints to manage campaigns via the REST API. - name: credentials description: Revoke compromised or leaked GitHub credentials. - name: projects description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: description: GitHub Enterprise Cloud REST API url: https://docs.github.com/enterprise-cloud@latest/rest/ paths: "/": get: summary: GitHub API Root description: Get Hypermedia links to resources accessible in GitHub's REST API tags: - meta operationId: meta/root responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/root" examples: default: "$ref": "#/components/examples/root" x-github: githubCloudOnly: false enabledForGitHubApps: true category: meta subcategory: meta externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#github-api-root "/advisories": get: summary: List global security advisories description: |- Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." tags: - security-advisories operationId: security-advisories/list-global-advisories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#list-global-security-advisories parameters: - name: ghsa_id in: query description: If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. schema: type: string - name: type in: query description: If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. schema: type: string enum: - reviewed - malware - unreviewed default: reviewed - name: cve_id description: If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. in: query schema: type: string - name: ecosystem in: query description: If specified, only advisories for these ecosystems will be returned. schema: "$ref": "#/components/schemas/security-advisory-ecosystems" - name: severity in: query description: If specified, only advisories with these severities will be returned. schema: type: string enum: - unknown - low - medium - high - critical - name: cwes in: query description: |- If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` schema: oneOf: - type: string - type: array items: type: string - name: is_withdrawn in: query description: Whether to only return advisories that have been withdrawn. schema: type: boolean - name: affects in: query description: |- If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` schema: oneOf: - type: string - type: array maxItems: 1000 items: type: string - name: published in: query description: |- If specified, only return advisories that were published on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." schema: type: string - name: updated in: query description: |- If specified, only return advisories that were updated on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." schema: type: string - name: modified description: |- If specified, only show advisories that were updated or published on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." in: query schema: type: string - name: epss_percentage in: query description: |- If specified, only return advisories that have an EPSS percentage score that matches the provided value. The EPSS percentage represents the likelihood of a CVE being exploited. schema: type: string - name: epss_percentile in: query description: |- If specified, only return advisories that have an EPSS percentile score that matches the provided value. The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/direction" - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer minimum: 1 maximum: 100 default: 30 - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - updated - published - epss_percentage - epss_percentile default: published responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/global-advisory" examples: default: "$ref": "#/components/examples/global-advisory-items" '429': description: Too many requests content: application/json: schema: "$ref": "#/components/schemas/basic-error" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: global-advisories "/advisories/{ghsa_id}": get: summary: Get a global security advisory description: Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. tags: - security-advisories operationId: security-advisories/get-global-advisory externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - "$ref": "#/components/parameters/ghsa_id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/global-advisory" examples: default: "$ref": "#/components/examples/global-advisory" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: global-advisories "/app": get: summary: Get the authenticated app description: |- 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](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-authenticated externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-the-authenticated-app parameters: [] responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/integration" examples: default: "$ref": "#/components/examples/integration" x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps "/app-manifests/{code}/conversions": post: summary: Create a GitHub App from a manifest description: Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. tags: - apps operationId: apps/create-from-manifest externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-github-app-from-a-manifest parameters: - name: code in: path required: true schema: type: string responses: '201': description: Response content: application/json: schema: allOf: - "$ref": "#/components/schemas/integration" - type: object properties: client_id: type: string client_secret: type: string webhook_secret: type: string nullable: true pem: type: string required: - client_id - client_secret - webhook_secret - pem additionalProperties: true examples: default: "$ref": "#/components/examples/integration-from-manifest" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps "/app/hook/config": get: summary: Get a webhook configuration for an app description: |- Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-webhook-config-for-app externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-webhook-configuration-for-an-app responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/webhook-config" examples: default: "$ref": "#/components/examples/webhook-config" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: webhooks patch: summary: Update a webhook configuration for an app description: |- Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/update-webhook-config-for-app externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#update-a-webhook-configuration-for-an-app requestBody: required: true content: application/json: schema: type: object properties: url: "$ref": "#/components/schemas/webhook-config-url" content_type: "$ref": "#/components/schemas/webhook-config-content-type" secret: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" examples: default: value: content_type: json insecure_ssl: '0' secret: "********" url: https://example.com/webhook responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/webhook-config" examples: default: "$ref": "#/components/examples/webhook-config" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: webhooks "/app/hook/deliveries": get: summary: List deliveries for an app webhook description: |- Returns a list of webhook deliveries for the webhook configured for a GitHub App. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/list-webhook-deliveries externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#list-deliveries-for-an-app-webhook parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/hook-delivery-item" examples: default: "$ref": "#/components/examples/hook-delivery-items" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: webhooks "/app/hook/deliveries/{delivery_id}": get: summary: Get a delivery for an app webhook description: |- Returns a delivery for the webhook configured for a GitHub App. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-webhook-delivery externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#get-a-delivery-for-an-app-webhook parameters: - "$ref": "#/components/parameters/delivery-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/hook-delivery" examples: default: "$ref": "#/components/examples/hook-delivery" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: webhooks "/app/hook/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an app webhook description: |- Redeliver a delivery for the webhook configured for a GitHub App. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/redeliver-webhook-delivery externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook parameters: - "$ref": "#/components/parameters/delivery-id" responses: '202': "$ref": "#/components/responses/accepted" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: webhooks "/app/installation-requests": get: summary: List installation requests for the authenticated app description: Lists all the pending installation requests for the authenticated GitHub App. tags: - apps operationId: apps/list-installation-requests-for-authenticated-app externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installation-requests-for-the-authenticated-app parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: List of integration installation requests content: application/json: schema: type: array items: "$ref": "#/components/schemas/integration-installation-request" examples: exampleKey1: "$ref": "#/components/examples/integration-installation-request-paginated" '304': "$ref": "#/components/responses/not_modified" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps "/app/installations": get: summary: List installations for the authenticated app description: |- The permissions the installation has are included under the `permissions` key. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/list-installations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/since" - name: outdated in: query required: false schema: type: string responses: '200': description: The permissions the installation has are included under the `permissions` key. content: application/json: schema: type: array items: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/base-installation-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps "/app/installations/{installation_id}": get: summary: Get an installation for the authenticated app description: |- Enables an authenticated GitHub App to find an installation's information using the installation id. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-installation-for-the-authenticated-app parameters: - "$ref": "#/components/parameters/installation-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/base-installation" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps delete: summary: Delete an installation for the authenticated app description: |- Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation)" endpoint. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/delete-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#delete-an-installation-for-the-authenticated-app parameters: - "$ref": "#/components/parameters/installation-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps "/app/installations/{installation_id}/access_tokens": post: summary: Create an installation access token for an app description: |- Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. Enterprise account installations do not have access to repositories and cannot be scoped down using the `permissions` parameter. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/create-installation-access-token externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app parameters: - "$ref": "#/components/parameters/installation-id" requestBody: required: false content: application/json: schema: type: object properties: repositories: description: List of repository names that the token should have access to type: array items: type: string example: rails repository_ids: description: List of repository IDs that the token should have access to example: - 1 type: array items: type: integer permissions: "$ref": "#/components/schemas/app-permissions" examples: default: value: repositories: - Hello-World permissions: issues: write contents: read responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/installation-token" examples: default: "$ref": "#/components/examples/installation-token" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps "/app/installations/{installation_id}/suspended": put: summary: Suspend an app installation description: |- Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/suspend-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation parameters: - "$ref": "#/components/parameters/installation-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps delete: summary: Unsuspend an app installation description: |- Removes a GitHub App installation suspension. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/unsuspend-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#unsuspend-an-app-installation parameters: - "$ref": "#/components/parameters/installation-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps "/applications/{client_id}/grant": delete: summary: Delete an app authorization description: |- OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). operationId: apps/delete-authorization tags: - apps externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-authorization parameters: - "$ref": "#/components/parameters/client-id" requestBody: required: true content: application/json: schema: type: object properties: access_token: type: string description: The OAuth access token used to authenticate to the GitHub API. required: - access_token examples: default: value: access_token: e72e16c7e42f292c6912e7710c838347ae178b4a responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: oauth-applications "/applications/{client_id}/token": post: summary: Check a token description: OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. tags: - apps operationId: apps/check-token externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#check-a-token parameters: - "$ref": "#/components/parameters/client-id" requestBody: required: true content: application/json: schema: properties: access_token: description: The access_token of the OAuth or GitHub application. type: string required: - access_token type: object examples: default: value: access_token: e72e16c7e42f292c6912e7710c838347ae178b4a responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/authorization" examples: default: "$ref": "#/components/examples/authorization-with-user" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: oauth-applications patch: summary: Reset a token description: OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. tags: - apps operationId: apps/reset-token externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#reset-a-token parameters: - "$ref": "#/components/parameters/client-id" requestBody: required: true content: application/json: schema: properties: access_token: description: The access_token of the OAuth or GitHub application. type: string required: - access_token type: object examples: default: value: access_token: e72e16c7e42f292c6912e7710c838347ae178b4a responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/authorization" examples: default: "$ref": "#/components/examples/authorization-with-user" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: oauth-applications delete: summary: Delete an app token description: OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. tags: - apps operationId: apps/delete-token externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/oauth-applications#delete-an-app-token parameters: - "$ref": "#/components/parameters/client-id" requestBody: required: true content: application/json: schema: type: object properties: access_token: type: string description: The OAuth access token used to authenticate to the GitHub API. required: - access_token examples: default: value: access_token: e72e16c7e42f292c6912e7710c838347ae178b4a responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: oauth-applications "/applications/{client_id}/token/scoped": post: summary: Create a scoped access token description: |- Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. Invalid tokens will return `404 NOT FOUND`. tags: - apps operationId: apps/scope-token externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-a-scoped-access-token parameters: - "$ref": "#/components/parameters/client-id" requestBody: required: true content: application/json: schema: type: object properties: access_token: type: string description: The access token used to authenticate to the GitHub API. example: e72e16c7e42f292c6912e7710c838347ae178b4a target: description: The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified. type: string example: octocat target_id: description: The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified. example: 1 type: integer repositories: description: The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. type: array items: type: string example: rails repository_ids: description: The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. example: - 1 type: array items: type: integer permissions: "$ref": "#/components/schemas/app-permissions" required: - access_token examples: default: value: access_token: e72e16c7e42f292c6912e7710c838347ae178b4a target: octocat permissions: metadata: read issues: write contents: read responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/authorization" examples: default: "$ref": "#/components/examples/scope-token" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps "/apps/{app_slug}": get: summary: Get an app description: |- > [!NOTE] > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). tags: - apps operationId: apps/get-by-slug externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app parameters: - "$ref": "#/components/parameters/app-slug" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/integration" examples: default: "$ref": "#/components/examples/integration" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps "/assignments/{assignment_id}": get: summary: Get an assignment description: Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/classroom-assignment" examples: default: "$ref": "#/components/examples/classroom-assignment" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: classroom subcategory: classroom "/assignments/{assignment_id}/accepted_assignments": get: summary: List accepted assignments for an assignment description: Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-accepted-assignments-for-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/classroom-accepted-assignment" examples: default: "$ref": "#/components/examples/classroom-accepted-assignment" x-github: enabledForGitHubApps: true category: classroom subcategory: classroom "/assignments/{assignment_id}/grades": get: summary: Get assignment grades description: Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-assignment-grades parameters: - "$ref": "#/components/parameters/assignment-id" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/classroom-assignment-grade" examples: default: "$ref": "#/components/examples/classroom-assignment-grades" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: classroom subcategory: classroom "/classrooms": get: summary: List classrooms description: Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-classrooms parameters: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-classroom" examples: default: "$ref": "#/components/examples/simple-classroom" x-github: enabledForGitHubApps: true category: classroom subcategory: classroom "/classrooms/{classroom_id}": get: summary: Get a classroom description: Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#get-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/classroom" examples: default: "$ref": "#/components/examples/classroom" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: classroom subcategory: classroom "/classrooms/{classroom_id}/assignments": get: summary: List assignments for a classroom description: Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/classroom/classroom#list-assignments-for-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-classroom-assignment" examples: default: "$ref": "#/components/examples/simple-classroom-assignment" x-github: enabledForGitHubApps: true category: classroom subcategory: classroom "/codes_of_conduct": get: summary: Get all codes of conduct description: Returns array of all GitHub's codes of conduct. tags: - codes-of-conduct operationId: codes-of-conduct/get-all-codes-of-conduct externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct parameters: [] responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-of-conduct" examples: default: "$ref": "#/components/examples/code-of-conduct-simple-items" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codes-of-conduct subcategory: codes-of-conduct "/codes_of_conduct/{key}": get: summary: Get a code of conduct description: Returns information about the specified GitHub code of conduct. tags: - codes-of-conduct operationId: codes-of-conduct/get-conduct-code externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct parameters: - name: key in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-of-conduct" examples: default: "$ref": "#/components/examples/code-of-conduct" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codes-of-conduct subcategory: codes-of-conduct "/credentials/revoke": post: summary: Revoke a list of credentials description: |- Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. This endpoint currently accepts the following credential types: - Personal access tokens (classic) - Fine-grained personal access tokens Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. > [!NOTE] > Any authenticated requests will return a 403. tags: - credentials operationId: credentials/revoke externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/credentials/revoke#revoke-a-list-of-credentials requestBody: required: true content: application/json: schema: type: object properties: credentials: type: array description: A list of credentials to be revoked, up to 1000 per request. items: type: string minItems: 1 maxItems: 1000 required: - credentials examples: default: value: credentials: - ghp_1234567890abcdef1234567890abcdef12345678 - ghp_abcdef1234567890abcdef1234567890abcdef12 responses: '202': "$ref": "#/components/responses/accepted" '422': "$ref": "#/components/responses/validation_failed_simple" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: credentials subcategory: revoke "/emojis": get: summary: Get emojis description: Lists all the emojis available to use on GitHub Enterprise Cloud. operationId: emojis/get tags: - emojis externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/emojis/emojis#get-emojis parameters: [] responses: '200': content: application/json: schema: type: object additionalProperties: type: string examples: default: "$ref": "#/components/examples/emojis-get" description: Response '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: emojis subcategory: emojis "/enterprise-installation/{enterprise_or_org}/server-statistics": get: summary: Get GitHub Enterprise Server statistics description: |- Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days. To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" in the GitHub Enterprise Server documentation. OAuth app tokens and personal access tokens (classic) need: - the `read:enterprise` scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics - the `read:org` scope if you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics operationId: enterprise-admin/get-server-statistics tags: - server-statistics - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics parameters: - "$ref": "#/components/parameters/enterprise-or-org" - name: date_start description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. in: query required: false schema: type: string - name: date_end description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/server-statistics" examples: default: "$ref": "#/components/examples/server-statistics" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: admin-stats "/enterprises/{enterprise}/access-restrictions/disable": post: summary: Disable access restrictions for an enterprise description: Disable access restriction by proxy header using the network proxy owned by the enterprise. operationId: enterprise-admin/disable-access-restrictions tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#disable-access-restrictions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/enterprise-access-restrictions" examples: default: value: message: Enterprise access restrictions successfully disabled. header_name: sec-GitHub-allowed-enterprise header_value: '12345' '400': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: enterprises "/enterprises/{enterprise}/access-restrictions/enable": post: summary: Enable access restrictions for an enterprise description: Enable access restriction by proxy header using the network proxy owned by the enterprise. operationId: enterprise-admin/enable-access-restrictions tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprises#enable-access-restrictions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/enterprise-access-restrictions" examples: default: value: message: Enterprise access restrictions successfully enabled. header_name: sec-GitHub-allowed-enterprise header_value: '12345' '400': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: enterprises "/enterprises/{enterprise}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for an enterprise description: |- Gets the total GitHub Actions cache usage for an enterprise. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: actions/get-actions-cache-usage-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-cache-usage-org-enterprise" examples: default: "$ref": "#/components/examples/actions-cache-usage-org-enterprise" headers: Link: "$ref": "#/components/headers/link" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: cache "/enterprises/{enterprise}/actions/hosted-runners": get: summary: List GitHub-hosted runners for an enterprise description: |- Lists all GitHub-hosted runners configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/list-hosted-runners-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runners properties: total_count: type: integer runners: type: array items: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners post: summary: Create a GitHub-hosted runner for an enterprise description: |- Creates a GitHub-hosted runner for an enterprise. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: actions/create-hosted-runner-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. type: string image: description: The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. type: object properties: id: description: The unique identifier of the runner image. type: string source: description: The source of the runner image. type: string enum: - github - partner - custom version: description: The version of the runner image to deploy. This is relevant only for runners using custom images. type: string nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string runner_group_id: description: The existing runner group to add this runner to. type: integer maximum_runners: description: The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. type: integer default: 50 enable_static_ip: description: Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean default: false image_gen: description: Whether this runner should be used to generate custom images. type: boolean default: false required: - name - image - size - runner_group_id examples: default: value: name: My Hosted runner image: id: ubuntu-latest source: github runner_group_id: 1 size: 4-core maximum_runners: 10 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/custom": get: summary: List custom images for an enterprise description: |- List custom images for an enterprise. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/list-custom-images-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - images properties: total_count: type: integer images: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-custom-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}": get: summary: Get an enterprise custom image definition for GitHub Actions Hosted Runners description: |- Get an enterprise custom image definition for GitHub Actions Hosted Runners. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/get-custom-image-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/actions-custom-image-definition-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner-custom-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners delete: summary: Delete a custom image from the enterprise description: |- Delete a custom image from the enterprise. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/delete-custom-image-from-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/actions-custom-image-definition-id" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions": get: summary: List image versions of a custom image for an enterprise description: |- List image versions of a custom image for an enterprise. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/list-custom-image-versions-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise parameters: - "$ref": "#/components/parameters/actions-custom-image-definition-id" - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - image_versions properties: total_count: type: integer image_versions: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": get: summary: Get an image version of an enterprise custom image for GitHub Actions Hosted Runners description: |- Get an image version of an enterprise custom image for GitHub Actions Hosted Runners. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/get-custom-image-version-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/actions-custom-image-definition-id" - "$ref": "#/components/parameters/actions-custom-image-version" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners delete: summary: Delete an image version of custom image from the enterprise description: |- Delete an image version of custom image from the enterprise. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/delete-custom-image-version-from-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/actions-custom-image-definition-id" - "$ref": "#/components/parameters/actions-custom-image-version" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an enterprise description: Get the list of GitHub-owned images available for GitHub-hosted runners for an enterprise. operationId: actions/get-hosted-runners-github-owned-images-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - images properties: total_count: type: integer images: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/images/partner": get: summary: Get partner images for GitHub-hosted runners in an enterprise description: Get the list of partner images available for GitHub-hosted runners for an enterprise. operationId: actions/get-hosted-runners-partner-images-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - images properties: total_count: type: integer images: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/limits": get: summary: Get limits on GitHub-hosted runners for an enterprise description: Get the GitHub-hosted runners limits for an enterprise. tags: - actions operationId: actions/get-hosted-runners-limits-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner-limits" examples: default: "$ref": "#/components/examples/actions-hosted-runner-limits-default" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/machine-sizes": get: summary: Get GitHub-hosted runners machine specs for an enterprise description: Get the list of machine specs available for GitHub-hosted runners for an enterprise. operationId: actions/get-hosted-runners-machine-specs-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - machine_specs properties: total_count: type: integer machine_specs: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" examples: default: "$ref": "#/components/examples/actions-hosted-runner-machine-spec" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/platforms": get: summary: Get platforms for GitHub-hosted runners in an enterprise description: Get the list of platforms available for GitHub-hosted runners for an enterprise. operationId: actions/get-hosted-runners-platforms-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - platforms properties: total_count: type: integer platforms: type: array items: type: string examples: default: value: total_count: 1 platforms: - linux-x64 - win-x64 x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/hosted-runners/{hosted_runner_id}": get: summary: Get a GitHub-hosted runner for an enterprise description: |- Gets a GitHub-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/get-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/hosted-runner-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: true enabledForGitHubApps: true category: actions subcategory: hosted-runners patch: summary: Update a GitHub-hosted runner for an enterprise description: |- Updates a GitHub-hosted runner for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: actions/update-hosted-runner-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/hosted-runner-id" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. type: string runner_group_id: description: The existing runner group to add this runner to. type: integer maximum_runners: description: The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. type: integer enable_static_ip: description: Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean image_version: description: The version of the runner image to deploy. This is relevant only for runners using custom images. type: string nullable: true examples: default: value: name: My Hosted runner runner_group_id: 1 maximum_runners: 50 enable_static_ip: false responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: hosted-runners delete: summary: Delete a GitHub-hosted runner for an enterprise description: Deletes a GitHub-hosted runner for an enterprise. operationId: actions/delete-hosted-runner-for-enterprise tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/hosted-runner-id" responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: hosted-runners "/enterprises/{enterprise}/actions/oidc/customization/issuer": put: summary: Set the GitHub Actions OIDC custom issuer policy for an enterprise description: |- Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - actions operationId: actions/set-actions-oidc-custom-issuer-policy-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Response requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-oidc-custom-issuer-policy-for-enterprise" examples: default: "$ref": "#/components/examples/actions-oidc-custom-issuer-policy-for-enterprise" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: oidc "/enterprises/{enterprise}/actions/permissions": get: summary: Get GitHub Actions permissions for an enterprise description: |- Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/get-github-actions-permissions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-enterprise-permissions" examples: default: "$ref": "#/components/examples/actions-enterprise-permissions" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions put: summary: Set GitHub Actions permissions for an enterprise description: |- Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/set-github-actions-permissions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: enabled_organizations: "$ref": "#/components/schemas/enabled-organizations" allowed_actions: "$ref": "#/components/schemas/allowed-actions" sha_pinning_required: "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_organizations examples: default: value: enabled_organizations: all allowed_actions: selected sha_pinning_required: true x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention": get: summary: Get artifact and log retention settings for an enterprise description: Gets artifact and log retention settings for an enterprise. operationId: enterprise-admin/get-artifact-and-log-retention-settings tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Successfully retrieved the artifact and log retention settings content: application/json: schema: "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" examples: default: summary: Example response value: days: 90 maximum_allowed_days: 365 '401': "$ref": "#/components/responses/authorization_failure" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions put: summary: Set artifact and log retention settings for an enterprise description: Sets artifact and log retention settings for an enterprise. operationId: enterprise-admin/set-artifact-and-log-retention-settings tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Successfully updated the artifact and log retention settings '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-artifact-and-log-retention" examples: default: summary: Set retention to 100 days value: days: 100 x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval": get: summary: Get fork PR contributor approval permissions for an enterprise description: Gets the fork PR contributor approval policy for an enterprise. operationId: enterprise-admin/get-fork-pr-contributor-approval-permissions tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: "$ref": "#/components/examples/actions-fork-pr-contributor-approval" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions put: summary: Set fork PR contributor approval permissions for an enterprise description: Sets the fork PR contributor approval policy for an enterprise. operationId: enterprise-admin/set-fork-pr-contributor-approval-permissions tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: summary: Set approval policy to first time contributors value: approval_policy: first_time_contributors x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos": get: summary: Get private repo fork PR workflow settings for an enterprise description: Gets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise. operationId: enterprise-admin/get-private-repo-fork-pr-workflows-settings tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" examples: default: "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions put: summary: Set private repo fork PR workflow settings for an enterprise description: Sets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise. operationId: enterprise-admin/set-private-repo-fork-pr-workflows-settings tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" examples: default: "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" responses: '204': description: Empty response for successful settings update '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/organizations": get: summary: List selected organizations enabled for GitHub Actions in an enterprise description: |- Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number organizations: type: array items: "$ref": "#/components/schemas/organization-simple" required: - total_count - organizations examples: default: "$ref": "#/components/examples/organization-targets" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions put: summary: Set selected organizations enabled for GitHub Actions in an enterprise description: |- Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: selected_organization_ids: description: List of organization IDs to enable for GitHub Actions. type: array items: type: integer description: Unique identifier of the organization. required: - selected_organization_ids examples: default: value: selected_organization_ids: - 32 - 91 x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": put: summary: Enable a selected organization for GitHub Actions in an enterprise description: |- Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/enable-selected-organization-github-actions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org-id" responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions delete: summary: Disable a selected organization for GitHub Actions in an enterprise description: |- Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/disable-selected-organization-github-actions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org-id" responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for an enterprise description: |- Gets the selected actions and reusable workflows 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](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/get-allowed-actions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/selected-actions" examples: default: "$ref": "#/components/examples/selected-actions" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions put: summary: Set allowed actions and reusable workflows for an enterprise description: |- Sets the actions and reusable workflows 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](#set-github-actions-permissions-for-an-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: enterprise-admin/set-allowed-actions-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Response requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/selected-actions" examples: selected_actions: "$ref": "#/components/examples/selected-actions" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/self-hosted-runners": get: summary: Get self-hosted runners permissions for an enterprise description: Gets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level. operationId: enterprise-admin/get-self-hosted-runners-permissions tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: object properties: disable_self_hosted_runners_for_all_orgs: type: boolean description: When true, repository-level runners will be disabled across all organizations in the enterprise required: - disable_self_hosted_runners_for_all_orgs examples: default: value: disable_self_hosted_runners_for_all_orgs: false '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions put: summary: Set self-hosted runners permissions for an enterprise description: Sets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level. operationId: enterprise-admin/set-self-hosted-runners-permissions tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: type: object properties: disable_self_hosted_runners_for_all_orgs: type: boolean description: When true, repository-level runners will be disabled across all organizations in the enterprise required: - disable_self_hosted_runners_for_all_orgs examples: default: summary: Disable repository-level runners across all organizations value: disable_self_hosted_runners_for_all_orgs: true x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions "/enterprises/{enterprise}/actions/permissions/workflow": get: summary: Get default workflow permissions for an enterprise description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - actions operationId: actions/get-github-actions-default-workflow-permissions-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Success response content: application/json: schema: "$ref": "#/components/schemas/actions-get-default-workflow-permissions" examples: default: "$ref": "#/components/examples/actions-default-workflow-permissions" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions put: summary: Set default workflow permissions for an enterprise description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets whether GitHub Actions can submit approving pull request reviews. For more information, see "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - actions operationId: actions/set-github-actions-default-workflow-permissions-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-set-default-workflow-permissions" examples: default: "$ref": "#/components/examples/actions-default-workflow-permissions" responses: '204': description: Success response x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: permissions "/enterprises/{enterprise}/actions/runner-groups": get: summary: List self-hosted runner groups for an enterprise description: |- Lists all self-hosted runner groups for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/list-self-hosted-runner-groups-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/visible-to-organization" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number runner_groups: type: array items: "$ref": "#/components/schemas/runner-groups-enterprise" required: - total_count - runner_groups examples: default: "$ref": "#/components/examples/runner-groups-enterprise" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups post: summary: Create a self-hosted runner group for an enterprise description: |- Creates a new 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. operationId: enterprise-admin/create-self-hosted-runner-group-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner group. type: string visibility: description: Visibility of a runner group. You can select all organizations or select individual organization. type: string enum: - selected - all selected_organization_ids: description: List of organization IDs that can access the runner group. type: array items: type: integer description: Unique identifier of the organization. runners: description: List of runner IDs to add to the runner group. type: array items: type: integer description: Unique identifier of the runner. allows_public_repositories: description: Whether the runner group can be used by `public` repositories. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main network_configuration_id: description: The identifier of a hosted compute network configuration. type: string required: - name examples: default: value: name: Expensive hardware runners visibility: selected selected_organization_ids: - 32 - 91 runners: - 9 - 2 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner-groups-enterprise" examples: default: "$ref": "#/components/examples/runner-group-enterprise" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": get: summary: Get a self-hosted runner group for an enterprise description: |- Gets a specific 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. operationId: enterprise-admin/get-self-hosted-runner-group-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner-groups-enterprise" examples: default: "$ref": "#/components/examples/runner-group-enterprise" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups patch: summary: Update a self-hosted runner group for an enterprise description: |- 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. operationId: enterprise-admin/update-self-hosted-runner-group-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" requestBody: required: false content: application/json: schema: type: object properties: name: description: Name of the runner group. type: string visibility: description: Visibility of a runner group. You can select all organizations or select individual organizations. type: string enum: - selected - all default: all allows_public_repositories: description: Whether the runner group can be used by `public` repositories. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main network_configuration_id: description: The identifier of a hosted compute network configuration. type: string nullable: true examples: default: value: name: Expensive hardware runners visibility: selected responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner-groups-enterprise" examples: default: "$ref": "#/components/examples/runner-group-update-enterprise" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups delete: summary: Delete a self-hosted runner group from an enterprise description: |- Deletes 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. operationId: enterprise-admin/delete-self-hosted-runner-group-from-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": get: summary: List organization access to a self-hosted runner group in an enterprise description: |- Lists the organizations with access to a self-hosted runner group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number organizations: type: array items: "$ref": "#/components/schemas/organization-simple" required: - total_count - organizations examples: default: "$ref": "#/components/examples/organization-targets" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups put: summary: Set organization access for a self-hosted runner group in an enterprise description: |- Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" requestBody: required: true content: application/json: schema: type: object properties: selected_organization_ids: description: List of organization IDs that can access the runner group. type: array items: type: integer description: Unique identifier of the organization. required: - selected_organization_ids examples: default: value: selected_organization_ids: - 32 - 91 responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": put: summary: Add organization access to a self-hosted runner group in an enterprise description: |- 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](#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. operationId: enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/org-id" responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups delete: summary: Remove organization access to a self-hosted runner group in an enterprise description: |- Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#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. operationId: enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/org-id" responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": get: summary: List self-hosted runners in a group for an enterprise description: |- Lists the self-hosted runners that are in a specific enterprise group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/list-self-hosted-runners-in-group-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number runners: type: array items: "$ref": "#/components/schemas/runner" required: - total_count - runners examples: default: "$ref": "#/components/examples/runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups put: summary: Set self-hosted runners in a group for an enterprise description: |- Replaces the list of self-hosted runners that are part of an enterprise runner group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/set-self-hosted-runners-in-group-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" requestBody: required: true content: application/json: schema: type: object properties: runners: description: List of runner IDs to add to the runner group. type: array items: type: integer description: Unique identifier of the runner. required: - runners examples: default: value: runners: - 9 - 2 responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": put: summary: Add a self-hosted runner to a group for an enterprise description: |- Adds a self-hosted runner to a runner group configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/add-self-hosted-runner-to-group-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/runner-id" responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups delete: summary: Remove a self-hosted runner from a group for an enterprise description: |- Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/runner-id" responses: '204': description: Response x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runner-groups "/enterprises/{enterprise}/actions/runners": get: summary: List self-hosted runners for an enterprise description: |- Lists all self-hosted runners configured for an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/list-self-hosted-runners-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise parameters: - name: name description: The name of a self-hosted runner. in: query schema: type: string - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: number runners: type: array items: "$ref": "#/components/schemas/runner" examples: default: "$ref": "#/components/examples/runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/actions/runners/downloads": get: summary: List runner applications for an enterprise description: |- Lists binaries for the runner application that you can download and run. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/list-runner-applications-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/runner-application" examples: default: "$ref": "#/components/examples/runner-application-items" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/actions/runners/generate-jitconfig": post: summary: Create configuration for a just-in-time runner for an Enterprise description: |- Generates a configuration that can be passed to the runner application at startup. OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - actions operationId: actions/generate-runner-jitconfig-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object required: - name - runner_group_id - labels properties: name: type: string description: The name of the new runner. runner_group_id: type: integer description: The ID of the runner group to register the runner to. labels: type: array minItems: 1 maxItems: 100 items: type: string description: 'The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.' work_folder: type: string description: The working directory to be used for job execution, relative to the runner install directory. default: _work examples: default: value: name: New runner runner_group_id: 1 labels: - self-hosted - X64 - macOS - no-gpu work_folder: _work responses: '201': "$ref": "#/components/responses/actions_runner_jitconfig" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/actions/runners/registration-token": post: summary: Create a registration token for an enterprise description: |- Returns a token that you can pass to the `config` script. The token expires after one hour. Example using registration token: Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. ``` ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN ``` OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/create-registration-token-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/authentication-token" examples: default: "$ref": "#/components/examples/authentication-token" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/actions/runners/remove-token": post: summary: Create a remove token for an enterprise description: |- 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: To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this endpoint. ``` ./config.sh remove --token TOKEN ``` OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/create-remove-token-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/authentication-token" examples: default: "$ref": "#/components/examples/authentication-token-2" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/actions/runners/{runner_id}": get: summary: Get a self-hosted runner for an enterprise description: |- Gets a specific self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/get-self-hosted-runner-for-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner" examples: default: "$ref": "#/components/examples/runner" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners delete: summary: Delete a self-hosted runner from an enterprise description: |- Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. operationId: enterprise-admin/delete-self-hosted-runner-from-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-id" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed_simple" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": get: summary: List labels for a self-hosted runner for an enterprise description: |- Lists all labels for a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-id" responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: self-hosted-runners post: summary: Add custom labels to a self-hosted runner for an enterprise description: |- Add custom labels to a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-id" requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 1 maxItems: 100 description: The names of the custom labels to add to the runner. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners put: summary: Set custom labels for a self-hosted runner for an enterprise description: |- Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-id" requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 0 maxItems: 100 description: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners delete: summary: Remove all custom labels from a self-hosted runner for an enterprise description: |- Remove all custom labels from a self-hosted runner configured in an enterprise. Returns the remaining read-only labels from the runner. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-id" responses: '200': "$ref": "#/components/responses/actions_runner_labels_readonly" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": delete: summary: Remove a custom label from a self-hosted runner for an enterprise description: |- Remove a custom label from a self-hosted runner configured in an enterprise. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/runner-id" - "$ref": "#/components/parameters/runner-label-name" responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: false category: actions subcategory: self-hosted-runners "/enterprises/{enterprise}/announcement": get: summary: Get announcement banner for enterprise description: Gets the announcement banner currently set for the enterprise. tags: - enterprise-admin operationId: announcement-banners/get-announcement-banner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#get-announcement-banner-for-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/announcement-banner" examples: default: "$ref": "#/components/examples/announcement" x-github: githubCloudOnly: true enabledForGitHubApps: false category: announcement-banners subcategory: enterprises patch: summary: Set announcement banner for enterprise description: Sets the announcement banner to display for the enterprise. tags: - enterprise-admin operationId: announcement-banners/set-announcement-banner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#set-announcement-banner-for-enterprise requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/announcement" examples: default: "$ref": "#/components/examples/announcement" parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/announcement-banner" examples: default: "$ref": "#/components/examples/announcement" x-github: githubCloudOnly: true enabledForGitHubApps: false category: announcement-banners subcategory: enterprises delete: summary: Remove announcement banner from enterprise description: Removes the announcement banner currently set for the enterprise. tags: - enterprise-admin operationId: announcement-banners/remove-announcement-banner-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/enterprises#remove-announcement-banner-from-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: false category: announcement-banners subcategory: enterprises "/enterprises/{enterprise}/apps/installable_organizations": get: summary: Get enterprise-owned organizations that can have GitHub Apps installed description: |- List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/installable-organizations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-enterprise-owned-organizations-that-can-have-github-apps-installed parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of organizations owned by the enterprise on which the authenticated GitHub App is installed. content: application/json: schema: type: array items: "$ref": "#/components/schemas/installable-organization" examples: default: value: - id: 1 login: github - id: 2 login: microsoft x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories": get: summary: Get repositories belonging to an enterprise-owned organization description: |- List the repositories belonging to an enterprise-owned organization that can be made accessible to a GitHub App installed on that organization. This API provides a shallow list of repositories in the organization, allowing the caller to then add or remove those repositories to an installation in that organization. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/installable-organization-accessible-repositories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of repositories owned by the enterprise organization on which the authenticated GitHub App is installed. content: application/json: schema: type: array items: "$ref": "#/components/schemas/accessible-repository" examples: default: value: - id: 1 name: Hello World full_name: octocat/Hello-World - id: 2 login: Goodbye World full_name: octocat/Goodbye-World x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations "/enterprises/{enterprise}/apps/organizations/{org}/installations": get: summary: List GitHub Apps installed on an enterprise-owned organization description: |- Lists the GitHub App installations associated with the given enterprise-owned organization. This lists all GitHub Apps that have been installed on the organization, regardless of who owns the application. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/organization-installations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of GitHub App installations that have been granted access to the organization content: application/json: schema: type: array items: "$ref": "#/components/schemas/enterprise-organization-installation" examples: default: value: - "$ref": "#/components/examples/enterprise-organization-installation" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations post: summary: Install a GitHub App on an enterprise-owned organization description: |- 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. If the app has a pending installation request, they will all be approved. 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 `repository_selection` is provided. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/create-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" responses: '200': description: A GitHub App installation that was installed previously. content: application/json: schema: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/base-installation" '201': description: A GitHub App installation. content: application/json: schema: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/base-installation" requestBody: required: true content: application/json: schema: type: object properties: client_id: type: string description: The Client ID of the GitHub App to install. repository_selection: type: string description: |- The repository selection for the GitHub App. Must be one of: * `all` - the installation can access all repositories in the organization. * `selected` - the installation can access only the listed repositories. * `none` - no repository permissions are requested. Only use when the app does not request repository permissions. enum: - all - selected - none repositories: type: array description: The names of the repositories to which the installation will be granted access. This is the simple name of the repository, not the full name (e.g., `hello-world` not `octocat/hello-world`). This is only required when `repository_selection` is `selected`. items: type: string maxItems: 50 required: - client_id - repository_selection examples: default: summary: Example of installing a GitHub App on an organization and granting access to all of its repositories. value: client_id: Iv2abc123aabbcc repository_selection: all repository_selection_selected: value: client_id: Iv2abc123aabbcc repository_selection: selected repositories: - hello-world - hello-world-2 x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}": delete: summary: Uninstall a GitHub App from an enterprise-owned organization description: |- Uninstall a GitHub App from an organization. Any app installed on the organization can be removed. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/delete-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/installation-id" responses: '204': description: An empty response indicates that the installation was successfully removed. '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories": get: summary: Get the repositories accessible to a given GitHub App installation description: |- Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/organization-installation-repositories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/installation-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of repositories owned by the enterprise organization to which the installation has access. content: application/json: schema: type: array items: "$ref": "#/components/schemas/accessible-repository" examples: default: value: - id: 1 name: Hello World full_name: octocat/Hello-World - id: 2 login: Goodbye World full_name: octocat/Goodbye-World x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations patch: summary: Toggle installation repository access between selected and all repositories description: |- Toggle repository access for a GitHub App installation between all repositories and selected repositories. You must provide at least one repository when changing the access to 'selected'. If you change the access to 'all', the repositories list must not be provided. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/change-installation-repository-access-selection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/installation-id" requestBody: required: true content: application/json: schema: type: object properties: repository_selection: type: string description: One of either 'all' or 'selected' enum: - all - selected repositories: type: array description: The repository names to add to the installation. Only required when repository_selection is 'selected' items: type: string maxItems: 50 required: - repository_selection examples: default: summary: Change the repositories accessible to a GitHub App from 'all repositories' to a specified subset. value: repository_selection: selected repositories: - hello-world - hello-world-2 responses: '200': description: The GitHub App installation that was updated. content: application/json: schema: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/base-installation" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add": patch: summary: Grant repository access to an organization installation description: |- Grant repository access to an organization installation. You can add up to 50 repositories at a time. If the installation already has access to the repository, it will not be added again. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/grant-repository-access-to-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/installation-id" responses: '200': description: A list of repositories which the authenticated GitHub App should be granted access to. content: application/json: schema: type: array items: "$ref": "#/components/schemas/accessible-repository" examples: default: value: - id: 1 name: Hello World full_name: octocat/Hello-World - id: 2 login: Goodbye World full_name: octocat/Goodbye-World requestBody: required: true content: application/json: schema: type: object properties: repositories: type: array description: The repository names to add to the installation. items: type: string maxItems: 50 required: - repositories examples: repositories: value: repositories: - hello-world - hello-world-2 x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove": patch: summary: Remove repository access from an organization installation description: |- Remove repository access from a GitHub App installed on an organization. You can remove up to 50 repositories at a time. You cannot remove repositories from an app installed on `all` repositories, nor can you remove the last repository for an app. If you attempt to do so, the API will return a 422 Unprocessable Entity error. This API can only be called by a GitHub App installed on the enterprise that owns the organization. tags: - apps operationId: enterprise-apps/remove-repository-access-to-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/installation-id" responses: '200': description: A list of repositories which the authenticated GitHub App has lost access to. content: application/json: schema: type: array items: "$ref": "#/components/schemas/accessible-repository" examples: default: value: - id: 1 name: Hello World full_name: octocat/Hello-World - id: 2 login: Goodbye World full_name: octocat/Goodbye-World '422': description: The request was well-formed but was unable to be followed due to semantic errors. This can happen if you attempt to remove a repository from an installation that has access to `all` repositories, or if you attempt to remove the last repository from an installation. content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: default: value: - message: Cannot remove the last repository from this installation. Uninstall this application instead. - documentation_url: https://docs.github.com/rest/enterprise-admin/organization-installations#remove-repository-access-to-an-organization-installation - status: 422 requestBody: required: true content: application/json: schema: type: object properties: repositories: type: array description: The repository names to remove from the installation. items: type: string maxItems: 50 required: - repositories examples: repositories: value: repositories: - hello-world - hello-world-2 x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: organization-installations "/enterprises/{enterprise}/audit-log": get: summary: Get the audit log for an enterprise operationId: enterprise-admin/get-audit-log description: |- Gets the audit log for an enterprise. 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 "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." The authenticated user must be an enterprise admin to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/audit-log-enterprise-phrase" - "$ref": "#/components/parameters/audit-log-include" - "$ref": "#/components/parameters/audit-log-after" - "$ref": "#/components/parameters/audit-log-before" - "$ref": "#/components/parameters/audit-log-order" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/audit-log-event" examples: default: "$ref": "#/components/examples/audit-log" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: audit-log "/enterprises/{enterprise}/audit-log/stream-key": get: summary: Get the audit log stream key for encrypting secrets description: |- Retrieves the audit log streaming public key for encrypting secrets. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." tags: - enterprise-admin operationId: enterprise-admin/get-audit-log-stream-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: The stream key for the audit log streaming configuration was retrieved successfully. content: application/json: schema: "$ref": "#/components/schemas/audit-log-stream-key" examples: default: "$ref": "#/components/examples/audit-log-stream-key" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: audit-log "/enterprises/{enterprise}/audit-log/streams": get: summary: List audit log stream configurations for an enterprise description: |- Lists the configured audit log streaming configurations for an enterprise. This only lists configured streams for supported providers. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." tags: - enterprise-admin operationId: enterprise-admin/get-audit-log-streams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/get-audit-log-stream-configs" examples: default: "$ref": "#/components/examples/get-audit-log-stream-configs" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: audit-log post: summary: Create an audit log streaming configuration for an enterprise description: |- Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." tags: - enterprise-admin operationId: enterprise-admin/create-audit-log-stream externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: enabled: type: boolean description: This setting pauses or resumes a stream. stream_type: type: string description: The audit log streaming provider. The name is case sensitive. enum: - Azure Blob Storage - Azure Event Hubs - Amazon S3 - Splunk - HTTPS Event Collector - Google Cloud Storage - Datadog vendor_specific: type: object oneOf: - "$ref": "#/components/schemas/azure-blob-config" - "$ref": "#/components/schemas/azure-hub-config" - "$ref": "#/components/schemas/amazon-s3-oidc-config" - "$ref": "#/components/schemas/amazon-s3-access-keys-config" - "$ref": "#/components/schemas/splunk-config" - "$ref": "#/components/schemas/hec-config" - "$ref": "#/components/schemas/google-cloud-config" - "$ref": "#/components/schemas/datadog-config" required: - enabled - stream_type - vendor_specific examples: default: "$ref": "#/components/examples/audit-log-stream-config-request" responses: '200': description: The audit log stream configuration was created successfully. content: application/json: schema: "$ref": "#/components/schemas/get-audit-log-stream-config" examples: default: "$ref": "#/components/examples/get-audit-log-stream-config" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: audit-log "/enterprises/{enterprise}/audit-log/streams/{stream_id}": get: summary: List one audit log streaming configuration via a stream ID description: |- Lists one audit log stream configuration via a stream ID. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." tags: - enterprise-admin operationId: enterprise-admin/get-one-audit-log-stream externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/audit-log-stream-id" responses: '200': description: Lists one audit log stream configuration via stream ID. content: application/json: schema: "$ref": "#/components/schemas/get-audit-log-stream-config" examples: default: "$ref": "#/components/examples/get-audit-log-stream-config" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: audit-log put: summary: Update an existing audit log stream configuration description: |- Updates an existing audit log stream configuration for an enterprise. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." tags: - enterprise-admin operationId: enterprise-admin/update-audit-log-stream externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/audit-log-stream-id" requestBody: required: true content: application/json: schema: type: object properties: enabled: type: boolean description: This setting pauses or resumes a stream. stream_type: type: string description: The audit log streaming provider. The name is case sensitive. enum: - Azure Blob Storage - Azure Event Hubs - Amazon S3 - Splunk - HTTPS Event Collector - Google Cloud Storage - Datadog vendor_specific: type: object oneOf: - "$ref": "#/components/schemas/azure-blob-config" - "$ref": "#/components/schemas/azure-hub-config" - "$ref": "#/components/schemas/amazon-s3-oidc-config" - "$ref": "#/components/schemas/amazon-s3-access-keys-config" - "$ref": "#/components/schemas/splunk-config" - "$ref": "#/components/schemas/hec-config" - "$ref": "#/components/schemas/google-cloud-config" - "$ref": "#/components/schemas/datadog-config" required: - enabled - stream_type - vendor_specific examples: default: "$ref": "#/components/examples/audit-log-stream-config-request" responses: '200': description: Successful update content: application/json: schema: "$ref": "#/components/schemas/get-audit-log-stream-config" examples: default: "$ref": "#/components/examples/get-audit-log-stream-config" '422': description: Validation error content: application/json: schema: type: object properties: errors: type: array items: type: string x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: audit-log delete: summary: Delete an audit log streaming configuration for an enterprise description: "Deletes an existing audit log stream configuration for an enterprise. \n\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api).\"" tags: - enterprise-admin operationId: enterprise-admin/delete-audit-log-stream externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/audit-log-stream-id" responses: '204': description: The audit log stream configuration was deleted successfully. x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: audit-log "/enterprises/{enterprise}/bypass-requests/push-rules": get: summary: List push rule bypass requests within an enterprise description: Lists the requests made by users of a repository to bypass push protection rules within an enterprise. tags: - enterprise-admin operationId: enterprise-admin/list-push-bypass-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/bypass-requests#list-push-rule-bypass-requests-within-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: bypass-requests parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org-name-in-query" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/bypass-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/push-rule-bypass-request" examples: default: "$ref": "#/components/examples/push-rule-bypass-request-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/enterprises/{enterprise}/bypass-requests/secret-scanning": get: summary: List bypass requests for secret scanning for an enterprise description: |- List requests to bypass secret scanning push protection in an enterprise. Delegated bypass must be enabled on repositories in the enterprise and the user must be a bypass reviewer to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/list-enterprise-bypass-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-enterprise x-github: githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: delegated-bypass parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org-name-in-query" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/bypass-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/secret-scanning-bypass-request" examples: default: "$ref": "#/components/examples/secret-scanning-bypass-request-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/enterprises/{enterprise}/code-scanning/alerts": get: summary: List code scanning alerts for an enterprise description: |- Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be a member of the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. tags: - code-scanning operationId: code-scanning/list-alerts-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/tool-name" - "$ref": "#/components/parameters/tool-guid" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false schema: "$ref": "#/components/schemas/code-scanning-alert-state-query" - name: sort description: The property by which to sort the results. in: query required: false schema: type: string enum: - created - updated default: created responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-organization-alert-items" examples: default: "$ref": "#/components/examples/code-scanning-organization-alert-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false previews: [] category: code-scanning subcategory: code-scanning "/enterprises/{enterprise}/code-security/configurations": get: summary: Get code security configurations for an enterprise description: |- Lists all code security configurations available in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/get-configurations-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - name: per_page in: query description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." required: false schema: type: integer default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/enterprise-code-security-configuration-list" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: code-security subcategory: configurations post: summary: Create a code security configuration for an enterprise description: |- Creates a code security configuration in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/create-configuration-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: name: type: string description: The name of the code security configuration. Must be unique within the enterprise. description: type: string description: A description of the code security configuration maxLength: 255 advanced_security: type: string description: | The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. > [!WARNING] > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled - code_security - secret_protection default: disabled code_security: type: string description: The enablement status of GitHub Code Security features. enum: - enabled - disabled - not_set dependency_graph: type: string description: The enablement status of Dependency Graph enum: - enabled - disabled - not_set default: enabled dependency_graph_autosubmit_action: type: string description: The enablement status of Automatic dependency submission enum: - enabled - disabled - not_set default: disabled dependency_graph_autosubmit_action_options: type: object description: Feature options for Automatic dependency submission properties: labeled_runners: type: boolean description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. default: false dependabot_alerts: type: string description: The enablement status of Dependabot alerts enum: - enabled - disabled - not_set default: disabled dependabot_security_updates: type: string description: The enablement status of Dependabot security updates enum: - enabled - disabled - not_set default: disabled code_scanning_options: "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: type: string description: The enablement status of code scanning default setup enum: - enabled - disabled - not_set default: disabled code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert dismissal enum: - enabled - disabled - not_set default: disabled secret_protection: type: string description: The enablement status of GitHub Secret Protection features. enum: - enabled - disabled - not_set secret_scanning: type: string description: The enablement status of secret scanning enum: - enabled - disabled - not_set default: disabled secret_scanning_push_protection: type: string description: The enablement status of secret scanning push protection enum: - enabled - disabled - not_set default: disabled secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks enum: - enabled - disabled - not_set default: disabled secret_scanning_non_provider_patterns: type: string description: The enablement status of secret scanning non provider patterns enum: - enabled - disabled - not_set default: disabled secret_scanning_generic_secrets: type: string description: The enablement status of Copilot secret scanning enum: - enabled - disabled - not_set default: disabled secret_scanning_delegated_alert_dismissal: type: string description: The enablement status of secret scanning delegated alert dismissal enum: - enabled - disabled - not_set default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting enum: - enabled - disabled - not_set default: disabled enforcement: type: string description: The enforcement status for a security configuration enum: - enforced - unenforced default: enforced required: - name - description examples: default: summary: Example for a code security configuration value: name: High rish settings description: This is a code security configuration for octo-enterprise advanced_security: enabled dependabot_alerts: enabled dependabot_security_updates: not_set secret_scanning: enabled responses: '201': description: Successfully created code security configuration content: application/json: schema: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/enterprise-code-security-configuration" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: code-security subcategory: configurations "/enterprises/{enterprise}/code-security/configurations/defaults": get: summary: Get default code security configurations for an enterprise description: |- Lists the default code security configurations for an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/get-default-configurations-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-security-default-configurations" examples: default: "$ref": "#/components/examples/code-security-default-configurations" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": get: summary: Retrieve a code security configuration of an enterprise description: |- Gets a code security configuration available in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/get-single-configuration-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/configuration-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/enterprise-code-security-configuration" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: code-security subcategory: configurations patch: summary: Update a custom code security configuration for an enterprise description: |- Updates a code security configuration in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/update-enterprise-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/configuration-id" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: name: type: string description: The name of the code security configuration. Must be unique across the enterprise. description: type: string description: A description of the code security configuration maxLength: 255 advanced_security: type: string description: | The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. > [!WARNING] > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled - code_security - secret_protection code_security: type: string description: The enablement status of GitHub Code Security features. enum: - enabled - disabled - not_set dependency_graph: type: string description: The enablement status of Dependency Graph enum: - enabled - disabled - not_set dependency_graph_autosubmit_action: type: string description: The enablement status of Automatic dependency submission enum: - enabled - disabled - not_set dependency_graph_autosubmit_action_options: type: object description: Feature options for Automatic dependency submission properties: labeled_runners: type: boolean description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. dependabot_alerts: type: string description: The enablement status of Dependabot alerts enum: - enabled - disabled - not_set dependabot_security_updates: type: string description: The enablement status of Dependabot security updates enum: - enabled - disabled - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup enum: - enabled - disabled - not_set code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert dismissal enum: - enabled - disabled - not_set default: disabled secret_protection: type: string description: The enablement status of GitHub Secret Protection features. enum: - enabled - disabled - not_set secret_scanning: type: string description: The enablement status of secret scanning enum: - enabled - disabled - not_set secret_scanning_push_protection: type: string description: The enablement status of secret scanning push protection enum: - enabled - disabled - not_set secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks enum: - enabled - disabled - not_set secret_scanning_non_provider_patterns: type: string description: The enablement status of secret scanning non-provider patterns enum: - enabled - disabled - not_set secret_scanning_generic_secrets: type: string description: The enablement status of Copilot secret scanning enum: - enabled - disabled - not_set default: disabled secret_scanning_delegated_alert_dismissal: type: string description: The enablement status of secret scanning delegated alert dismissal enum: - enabled - disabled - not_set default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting enum: - enabled - disabled - not_set enforcement: type: string description: The enforcement status for a security configuration enum: - enforced - unenforced examples: default: summary: Example for updating a code security configuration value: name: octo-enterprise recommended settings v2 secret_scanning: disabled code_scanning_default_setup: enabled responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/enterprise-code-security-configuration" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: false category: code-security subcategory: configurations delete: summary: Delete a code security configuration for an enterprise description: |- Deletes a code security configuration from an enterprise. Repositories attached to the configuration will retain their settings but will no longer be associated with the configuration. The authenticated user must be an administrator for the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/delete-configuration-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/configuration-id" responses: '204': "$ref": "#/components/responses/no_content" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: false category: code-security subcategory: configurations "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": post: summary: Attach an enterprise configuration to repositories description: |- Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. The authenticated user must be an administrator for the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/attach-enterprise-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/configuration-id" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: scope: type: string description: The type of repositories to attach the configuration to. enum: - all - all_without_configurations required: - scope examples: default: summary: Example for attaching a configuration to some repositories value: scope: all responses: '202': "$ref": "#/components/responses/accepted" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": put: summary: Set a code security configuration as a default for an enterprise description: |- Sets a code security configuration as a default to be applied to new repositories in your enterprise. This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. The authenticated user must be an administrator for the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/set-configuration-as-default-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/configuration-id" requestBody: required: true content: application/json: schema: type: object properties: default_for_new_repos: type: string description: Specify which types of repository this security configuration should be applied to by default. enum: - all - none - private_and_internal - public examples: default: summary: Set this configuration to be enabled by default on all new repositories. value: default_for_new_repos: all responses: '200': description: Default successfully changed. content: application/json: schema: type: object properties: default_for_new_repos: type: string description: Specifies which types of repository this security configuration is applied to by default. enum: - all - none - private_and_internal - public configuration: "$ref": "#/components/schemas/code-security-configuration" examples: default: value: default_for_new_repos: all configuration: "$ref": "#/components/examples/code-security-configuration" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": get: summary: Get repositories associated with an enterprise code security configuration description: |- Lists the repositories associated with an enterprise code security configuration in an organization. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - code-security operationId: code-security/get-repositories-for-enterprise-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/configuration-id" - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: integer default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` in: query required: false schema: type: string default: all responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-security-configuration-repositories" examples: default: summary: Example of code security configuration repositories value: - status: attached repository: "$ref": "#/components/examples/simple-repository" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: code-security subcategory: configurations "/enterprises/{enterprise}/code_security_and_analysis": get: summary: Get code security and analysis features for an enterprise description: |- > [!WARNING] > **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Gets code security and analysis settings for the specified enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: secret-scanning/get-security-analysis-settings-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/enterprise-security-analysis-settings" examples: default: "$ref": "#/components/examples/enterprise-security-analysis-settings" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis deprecationDate: '2024-09-27' removalDate: '2025-09-27' deprecated: true patch: summary: Update code security and analysis features for an enterprise description: |- > [!WARNING] > **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: secret-scanning/patch-security-analysis-settings-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: false content: application/json: schema: type: object properties: advanced_security_enabled_for_new_repositories: type: boolean description: Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." advanced_security_enabled_new_user_namespace_repos: type: boolean description: Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." dependabot_alerts_enabled_for_new_repositories: type: boolean description: Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." secret_scanning_enabled_for_new_repositories: type: boolean description: Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." secret_scanning_push_protection_custom_link: type: string nullable: true description: |- The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." To disable this functionality, set this field to `null`. secret_scanning_non_provider_patterns_enabled_for_new_repositories: type: boolean nullable: true description: Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise. examples: default: value: advanced_security_enabled_for_new_repositories: true advanced_security_enabled_new_user_namespace_repos: true dependabot_alerts_enabled_for_new_repositories: true secret_scanning_enabled_for_new_repositories: true secret_scanning_push_protection_enabled_for_new_repositories: true secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md secret_scanning_non_provider_patterns_enabled_for_new_repositories: true responses: '204': description: Action started '422': description: The action could not be taken due to an in progress enablement, or a policy is preventing enablement '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis deprecationDate: '2024-09-27' removalDate: '2025-09-27' deprecated: true "/enterprises/{enterprise}/consumed-licenses": get: summary: List enterprise consumed licenses description: |- Lists the license consumption information for all users, including those from connected servers, associated with an enterprise. The authenticated user must be an enterprise admin to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/get-consumed-licenses externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/license#list-enterprise-consumed-licenses parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Consumed Licenses Response content: application/json: schema: "$ref": "#/components/schemas/get-consumed-licenses" examples: default: "$ref": "#/components/examples/get-consumed-licenses" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: true enabledForGitHubApps: false previews: [] category: enterprise-admin subcategory: license "/enterprises/{enterprise}/copilot/billing/seats": get: summary: List all Copilot seat assignments for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/page" - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 50 responses: '200': description: Response content: application/json: schema: type: object properties: total_seats: type: integer description: The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. seats: type: array items: "$ref": "#/components/schemas/copilot-seat-details" examples: default: "$ref": "#/components/examples/copilot-seats-list" headers: Link: "$ref": "#/components/headers/link" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management "/enterprises/{enterprise}/copilot/billing/selected_enterprise_teams": post: summary: Add enterprise teams to the Copilot subscription for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified enterprise team. The enterprise will be billed accordingly. Only enterprise owners can purchase Copilot seats for their enterprise members. The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-enterprise-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-enterprise-teams-to-the-copilot-subscription-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: content: application/json: schema: type: object properties: selected_enterprise_teams: type: array description: List of enterprise team names within the enterprise to which to grant access to GitHub Copilot. items: type: string minItems: 1 required: - selected_enterprise_teams examples: default: value: selected_enterprise_teams: - engteam1 - engteam2 - engteam3 required: true responses: '201': description: OK content: application/json: schema: type: object description: The total number of seats created for the members of the specified enterprise team(s). properties: seats_created: type: integer required: - seats_created examples: default: value: seats_created: 5 '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business is not enabled for this enterprise, billing has not been set up for this enterprise or a public code suggestions policy has not been set for this enterprise. x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management delete: summary: Remove enterprise teams from the Copilot subscription for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Sets seats for all members of each enterprise team specified to "pending cancellation". This will cause the members of the specified enterprise team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another enterprise team. Only enterprise owners can cancel Copilot seats for their enterprise members. The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seats-for-enterprise-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-enterprise-teams-from-the-copilot-subscription-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: content: application/json: schema: type: object properties: selected_enterprise_teams: type: array description: List of enterprise team names within the enterprise to which to grant access to GitHub Copilot. items: type: string minItems: 1 required: - selected_enterprise_teams examples: default: value: selected_enterprise_teams: - engteam1 - engteam2 - engteam3 required: true responses: '200': description: OK content: application/json: schema: type: object description: The total number of seats set to "pending cancellation" for the members of the specified enterprise team(s). properties: seats_cancelled: type: integer required: - seats_cancelled examples: default: value: seats_cancelled: 5 '202': description: Response content: application/json: schema: type: object properties: message: type: string examples: response: value: message: Status for delete command '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business is not enabled for this enterprise, billing has not been set up for this enterprise or a public code suggestions policy has not been set for this enterprise. x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management "/enterprises/{enterprise}/copilot/billing/selected_users": post: summary: Add users to the Copilot subscription for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. The enterprise will be billed accordingly. Only enterprise owners can purchase Copilot seats for their enterprise members. The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-enterprise-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: content: application/json: schema: type: object properties: selected_usernames: type: array description: The usernames of the enterprise members to be granted access to GitHub Copilot. items: type: string minItems: 1 required: - selected_usernames examples: default: value: selected_usernames: - cooluser1 - hacker2 - octocat required: true responses: '201': description: OK content: application/json: schema: type: object description: The total number of seats created for the specified user(s). properties: seats_created: type: integer required: - seats_created examples: default: value: seats_created: 5 '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot is not enabled for this enterprise, billing has not been set up for this enterprise, a public code suggestions policy has not been set for this enterprise, or the enterprise's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: true enabledForGitHubApps: false category: copilot subcategory: copilot-user-management delete: summary: Remove users from the Copilot subscription for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team or organization membership. Only enterprise owners can cancel Copilot seats for their enterprise members. The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seats-for-enterprise-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: content: application/json: schema: type: object properties: selected_usernames: type: array description: The usernames of the enterprise members for which to revoke access to GitHub Copilot. items: type: string minItems: 1 required: - selected_usernames examples: default: value: selected_usernames: - cooluser1 - hacker2 - octocat required: true responses: '200': description: OK content: application/json: schema: type: object description: The total number of seats set to "pending cancellation" for the specified users. properties: seats_cancelled: type: integer required: - seats_cancelled examples: default: value: seats_cancelled: 5 '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot is not enabled for this enterprise, billing has not been set up for this enterprise, a public code suggestions policy has not been set for this enterprise, or the enterprise's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: true enabledForGitHubApps: false category: copilot subcategory: copilot-user-management "/enterprises/{enterprise}/copilot/metrics": get: summary: Get Copilot metrics for an enterprise description: |- Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. Only enterprise owners and billing managers can view Copilot metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-metrics-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. in: query required: false schema: type: string - name: until description: Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. in: query required: false schema: type: string - "$ref": "#/components/parameters/page" - name: per_page description: The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 100 responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/copilot-usage-metrics-day" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-for-day" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": get: summary: Get Copilot enterprise usage metrics for a specific day description: |- Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise. The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-enterprise-one-day-usage-metrics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/day" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": get: summary: Get Copilot enterprise usage metrics description: |- Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise. The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-enterprise-usage-metrics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day description: |- Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-users-one-day-usage-metrics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/day" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": get: summary: Get Copilot users usage metrics description: |- Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-users-usage-metrics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise description: |- Lists Dependabot alerts for repositories that are owned by the specified enterprise. The authenticated user must be a member of the enterprise to use this endpoint. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-alerts-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-states" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/dependabot-alert-with-repository" examples: default: "$ref": "#/components/examples/dependabot-alerts-for-organization" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: false previews: [] category: dependabot subcategory: alerts "/enterprises/{enterprise}/enterprise-roles": get: summary: Get all enterprise roles for an enterprise description: |- Lists the enterprise roles available in this enterprise. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `read_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint. tags: - enterprise-admin operationId: enterprise-admin/list-enterprise-roles externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-all-enterprise-roles-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response - list of enterprise roles content: application/json: schema: type: object properties: total_count: type: integer description: The total number of enterprise roles available to the enterprise. roles: type: array description: The list of enterprise roles available to the enterprise. items: "$ref": "#/components/schemas/enterprise-role" examples: default: "$ref": "#/components/examples/enterprise-role-list" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/enterprise-roles/teams/{team_slug}": delete: summary: Remove all enterprise roles from a team description: |- Removes all assigned enterprise roles from a team in an enterprise. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `write_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/revoke-all-enterprise-roles-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team-slug" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Response if the enterprise roles feature is not enabled for the enterprise, or validation failed. x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/enterprise-roles/teams/{team_slug}/{role_id}": put: summary: Assign an enterprise role to a team description: |- Assigns an enterprise role to a team in an enterprise. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `write_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/assign-team-to-enterprise-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team-slug" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Response if the enterprise roles feature is not enabled for the enterprise, or validation failed. x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles delete: summary: Remove an enterprise role from a team description: |- Removes an enterprise role from a team in an enterprise. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `write_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/revoke-enterprise-role-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team-slug" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Response if the enterprise roles feature is not enabled for the enterprise, or validation failed. x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/enterprise-roles/users/{username}": delete: summary: Remove all enterprise roles from a user description: |- Removes all enterprise roles from an enterprise user in an enterprise. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `write_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/remove-all-enterprise-roles-from-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/username" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Response if the enterprise roles feature is not enabled for the enterprise, or validation failed. x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/enterprise-roles/users/{username}/{role_id}": put: summary: Assign an enterprise role to an enterprise user description: |- Assigns an enterprise role to a user in an enterprise. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `write_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/assign-enterprise-role-to-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Response if the enterprise roles feature is not enabled for the enterprise, or validation failed. x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles delete: summary: Remove enterprise user role assignment description: |- Removes an enterprise role from an enterprise user. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `write_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/remove-enterprise-user-role-assignment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Response if the enterprise roles feature is not enabled for the enterprise, or validation failed. x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/enterprise-roles/{role_id}": get: summary: Get an enterprise role description: |- Gets a custom enterprise role that is available within the enterprise. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `read_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint. tags: - enterprise-admin operationId: enterprise-admin/get-enterprise-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-an-enterprise-role parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/role-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/enterprise-role" examples: default: "$ref": "#/components/examples/enterprise-role" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/enterprise-roles/{role_id}/teams": get: summary: List teams that are assigned to an enterprise role description: |- Lists the teams that are assigned to an enterprise role. To use this endpoint, the authenticated user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `read_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) require the `read:enterprise` scope to access this endpoint. tags: - enterprise-admin operationId: enterprise-admin/list-enterprise-role-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/role-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/enterprise-team" examples: default: "$ref": "#/components/examples/enterprise-teams-items" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/enterprise-roles/{role_id}/users": get: summary: List users that are assigned to an enterprise role description: |- Lists enterprise members that are assigned to an enterprise role. To use this endpoint, a user must be one of: - An administrator for the enterprise. - A user, or a user on a team, with the fine-grained permission `read_enterprise_custom_enterprise_role` in the enterprise. OAuth app tokens and personal access tokens (classic) require the `enterprise:admin` scope to access this endpoint. tags: - enterprise-admin operationId: enterprise-admin/list-enterprise-role-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/role-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response - List of assigned users content: application/json: schema: type: array description: List of users assigned to the enterprise role items: "$ref": "#/components/schemas/enterprise-user-role-assignment" examples: default: "$ref": "#/components/examples/enterprise-user-role-assignments" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: enterprise-roles "/enterprises/{enterprise}/license-sync-status": get: summary: Get a license sync status description: |- Gets information about the status of a license sync job for an enterprise. The authenticated user must be an enterprise admin to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: enterprise-admin/get-license-sync-status externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/license#get-a-license-sync-status parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: License Sync Status Response content: application/json: schema: "$ref": "#/components/schemas/get-license-sync-status" examples: default: "$ref": "#/components/examples/get-license-sync-status" x-github: githubCloudOnly: true enabledForGitHubApps: false previews: [] category: enterprise-admin subcategory: license "/enterprises/{enterprise}/members/{username}/copilot": get: summary: Get Copilot seat assignment details for an enterprise user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets the GitHub Copilot seat details for a member of an enterprise who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. Only enterprise owners can view Copilot seat assignment details for members of their enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-enterprise-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/username" responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: schema: type: object properties: total_seats: type: integer description: The total number of Copilot seats the enterprise is being billed for. Users with access through enterprise, enterprise teams or multiple organizations are only counted once. seats: type: array items: "$ref": "#/components/schemas/copilot-seat-details" examples: default: "$ref": "#/components/examples/copilot-seats-list" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business or Enterprise is not enabled for this enterprise. x-github: githubCloudOnly: true enabledForGitHubApps: false category: copilot subcategory: copilot-user-management "/enterprises/{enterprise}/network-configurations": get: summary: List hosted compute network configurations for an enterprise description: Lists all hosted compute network configurations configured in an enterprise. tags: - enterprise-admin - hosted-compute operationId: hosted-compute/list-network-configurations-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#list-hosted-compute-network-configurations-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - network_configurations properties: total_count: type: integer network_configurations: type: array items: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configurations-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations post: summary: Create a hosted compute network configuration for an enterprise description: Creates a hosted compute network configuration for an enterprise. tags: - enterprise-admin - hosted-compute operationId: hosted-compute/create-network-configuration-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#create-a-hosted-compute-network-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, `.`, `-`, and `_`. type: string compute_service: description: The hosted compute service to use for the network configuration. type: string enum: - none - actions network_settings_ids: type: array minItems: 1 maxItems: 1 description: The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. items: type: string required: - name - network_settings_ids examples: default: value: name: my-network-configuration network_settings_ids: - 23456789ABDCEF1 compute_service: actions responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configuration" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations "/enterprises/{enterprise}/network-configurations/{network_configuration_id}": get: summary: Get a hosted compute network configuration for an enterprise description: Gets a hosted compute network configuration configured in an enterprise. tags: - enterprise-admin - hosted-compute operationId: hosted-compute/get-network-configuration-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/network-configuration-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configuration" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations patch: summary: Update a hosted compute network configuration for an enterprise description: Updates a hosted compute network configuration for an enterprise. tags: - enterprise-admin - hosted-compute operationId: hosted-compute/update-network-configuration-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/network-configuration-id" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, `.`, `-`, and `_`. type: string compute_service: description: The hosted compute service to use for the network configuration. type: string enum: - none - actions network_settings_ids: type: array minItems: 0 maxItems: 1 description: The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. items: type: string examples: default: value: name: my-network-configuration network_settings_ids: - 23456789ABDCEF1 compute_service: actions responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configuration" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations delete: summary: Delete a hosted compute network configuration from an enterprise description: Deletes a hosted compute network configuration from an enterprise. tags: - enterprise-admin - hosted-compute operationId: hosted-compute/delete-network-configuration-from-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/network-configuration-id" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations "/enterprises/{enterprise}/network-settings/{network_settings_id}": get: summary: Get a hosted compute network settings resource for an enterprise description: Gets a hosted compute network settings resource configured for an enterprise. tags: - enterprise-admin - hosted-compute operationId: hosted-compute/get-network-settings-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/network-settings-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-settings" examples: default: "$ref": "#/components/examples/network-settings" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: network-configurations "/enterprises/{enterprise}/org-properties/schema": get: summary: Get organization custom properties schema for an enterprise description: |- Gets all organization custom property definitions that are defined on an enterprise. Access requirements: - Enterprise admins - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definitions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-organization-custom-properties-schema-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-custom-property" examples: default: "$ref": "#/components/examples/organization-custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties-for-orgs patch: summary: Create or update organization custom property definitions on an enterprise description: |- Creates new or updates existing organization custom properties defined on an enterprise in a batch. If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. Access requirements: - Enterprise admins - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definitions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-organization-custom-property-definitions-on-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: properties: type: array description: The array of organization custom properties to create or update. items: "$ref": "#/components/schemas/organization-custom-property" minItems: 1 maxItems: 100 required: - properties examples: default: "$ref": "#/components/examples/organization-custom-properties" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-custom-property" examples: default: "$ref": "#/components/examples/organization-custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties-for-orgs "/enterprises/{enterprise}/org-properties/schema/{custom_property_name}": get: summary: Get an organization custom property definition from an enterprise description: |- Gets an organization custom property definition that is defined on an enterprise. Access requirements: - Enterprise admins - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-property" examples: default: "$ref": "#/components/examples/organization-custom-property" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties-for-orgs put: summary: Create or update an organization custom property definition on an enterprise description: |- Creates a new or updates an existing organization custom property definition that is defined on an enterprise. Access requirements: - Enterprise admins - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-custom-property-payload" examples: default: value: value_type: single_select required: true default_value: production description: Prod or dev environment allowed_values: - production - development responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-property" examples: default: "$ref": "#/components/examples/organization-custom-property" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties-for-orgs delete: summary: Remove an organization custom property definition from an enterprise description: |- Removes an organization custom property definition that is defined on an enterprise. Access requirements: - Enterprise admins - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope - Actors with the enterprise-level "manage enterprise custom properties for organizations" fine-grained permission tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-orgs-delete-enterprise-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" responses: '204': "$ref": "#/components/responses/no_content" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties-for-orgs "/enterprises/{enterprise}/org-properties/values": get: summary: List custom property values for organizations in an enterprise description: |- Lists enterprise organizations with all of their custom property values. Access requirements: - Enterprise admins - OAuth tokens and personal access tokens (classic) with the `read:enterprise` scope - Actors with the enterprise-level "read enterprise custom properties for organizations" fine-grained permission or above tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-orgs-get-enterprise-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#list-custom-property-values-for-organizations-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/custom-properties-for-orgs-get-enterprise-property-values" examples: default: "$ref": "#/components/examples/custom-properties-for-orgs-get-enterprise-property-values" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties-for-orgs patch: summary: Create or update custom property values for organizations in an enterprise description: |- Create or update custom property values for organizations in an enterprise. To remove a custom property value from an organization, set the property value to `null`. Access requirements: - Enterprise admins - OAuth tokens and personal access tokens (classic) with the `admin:enterprise` scope - Actors with the enterprise-level "edit enterprise custom properties for organizations" fine-grained permission or above tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-orgs-create-or-update-enterprise-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-custom-property-values-for-organizations-in-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: organization_logins: type: array description: The names of organizations that the custom property values will be applied to. items: type: string minItems: 1 maxItems: 30 properties: type: array description: List of custom property names and associated values to apply to the organizations. items: "$ref": "#/components/schemas/custom-property-value" required: - organization_logins - properties examples: default: "$ref": "#/components/examples/custom-properties-for-orgs-patch-enterprise-property-values" responses: '204': description: No Content when custom property values are successfully created or updated '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties-for-orgs "/enterprises/{enterprise}/properties/schema": get: summary: Get custom properties for an enterprise description: |- Gets all custom properties defined for an enterprise. Enterprise members can read these properties. tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-repos-get-enterprise-definitions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties patch: summary: Create or update custom properties for an enterprise description: |- Creates new or updates existing custom properties defined for an enterprise in a batch. If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. To use this endpoint, the authenticated user must be an administrator for the enterprise. tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definitions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: properties: type: array description: The array of custom properties to create or update. items: "$ref": "#/components/schemas/custom-property" minItems: 1 maxItems: 100 required: - properties examples: default: value: properties: - property_name: environment value_type: single_select required: true default_value: production description: Prod or dev environment allowed_values: - production - development values_editable_by: org_actors - property_name: service value_type: string - property_name: team value_type: string description: Team owning the repository responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote": put: summary: Promote a custom property to an enterprise description: |- Promotes an existing organization custom property to an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-repos-promote-definition-to-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/custom-property-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties "/enterprises/{enterprise}/properties/schema/{custom_property_name}": get: summary: Get a custom property for an enterprise description: |- Gets a custom property that is defined for an enterprise. Enterprise members can read these properties. tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-repos-get-enterprise-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties put: summary: Create or update a custom property for an enterprise description: |- Creates a new or updates an existing custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-repos-create-or-update-enterprise-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: value_type: single_select required: true default_value: production description: Prod or dev environment allowed_values: - production - development responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties delete: summary: Remove a custom property for an enterprise description: |- Remove a custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. tags: - enterprise-admin operationId: enterprise-admin/custom-properties-for-repos-delete-enterprise-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" responses: '204': "$ref": "#/components/responses/no_content" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties "/enterprises/{enterprise}/rulesets": post: summary: Create an enterprise repository ruleset description: Create a repository ruleset for an enterprise. tags: - repos operationId: repos/create-enterprise-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset parameters: - "$ref": "#/components/parameters/enterprise" requestBody: description: Request body required: true content: application/json: schema: type: object properties: name: type: string description: The name of the ruleset. target: type: string description: The target of the ruleset enum: - branch - tag - push - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: type: array description: The actors that can bypass the rules in this ruleset items: "$ref": "#/components/schemas/repository-ruleset-bypass-actor" conditions: "$ref": "#/components/schemas/enterprise-ruleset-conditions" rules: type: array description: An array of rules within the ruleset. items: "$ref": "#/components/schemas/enterprise-rules" required: - name - enforcement examples: default: value: name: super cool ruleset target: repository enforcement: active bypass_actors: - actor_id: 234 actor_type: Team bypass_mode: always conditions: org_name: include: - important_org exclude: - unimportant_org rules: - type: repository_delete responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/enterprise-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: rules "/enterprises/{enterprise}/rulesets/{ruleset_id}": get: summary: Get an enterprise repository ruleset description: |- Get a repository ruleset for an enterprise. **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user making the API request has write access to the ruleset. tags: - repos operationId: repos/get-enterprise-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset parameters: - "$ref": "#/components/parameters/enterprise" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/enterprise-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: rules put: summary: Update an enterprise repository ruleset description: Update a ruleset for an enterprise. tags: - repos operationId: repos/update-enterprise-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset parameters: - "$ref": "#/components/parameters/enterprise" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer requestBody: description: Request body required: false content: application/json: schema: type: object properties: name: type: string description: The name of the ruleset. target: type: string description: The target of the ruleset enum: - branch - tag - push - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: type: array description: The actors that can bypass the rules in this ruleset items: "$ref": "#/components/schemas/repository-ruleset-bypass-actor" conditions: "$ref": "#/components/schemas/enterprise-ruleset-conditions" rules: description: An array of rules within the ruleset. type: array items: "$ref": "#/components/schemas/enterprise-rules" examples: default: value: name: super cool ruleset target: repository enforcement: active bypass_actors: - actor_id: 234 actor_type: Team bypass_mode: always conditions: org_name: include: - important_org exclude: - unimportant_org rules: - type: repository_delete responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/enterprise-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: rules delete: summary: Delete an enterprise repository ruleset description: Delete a ruleset for an enterprise. tags: - repos operationId: repos/delete-enterprise-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset parameters: - "$ref": "#/components/parameters/enterprise" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: true category: enterprise-admin subcategory: rules "/enterprises/{enterprise}/rulesets/{ruleset_id}/history": get: summary: Get enterprise ruleset history description: Get the history of an enterprise ruleset. tags: - enterprise-admin operationId: enterprise-admin/get-enterprise-ruleset-history externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-history parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/ruleset-version" examples: default: "$ref": "#/components/examples/ruleset-history" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: rules "/enterprises/{enterprise}/rulesets/{ruleset_id}/history/{version_id}": get: summary: Get enterprise ruleset version description: Get a version of an enterprise ruleset. tags: - enterprise-admin operationId: enterprise-admin/get-enterprise-ruleset-version externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-enterprise-ruleset-version parameters: - "$ref": "#/components/parameters/enterprise" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer - name: version_id description: The ID of the version in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/ruleset-version-with-state" examples: default: "$ref": "#/components/examples/enterprise-ruleset-version-with-state" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: rules "/enterprises/{enterprise}/secret-scanning/alerts": get: summary: List secret scanning alerts for an enterprise description: |- Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. tags: - secret-scanning operationId: secret-scanning/list-alerts-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/secret-scanning-alert-validity" - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-secret-scanning-alert" examples: default: "$ref": "#/components/examples/organization-secret-scanning-alert-list" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning "/enterprises/{enterprise}/secret-scanning/pattern-configurations": get: summary: List enterprise pattern configurations description: |- Lists the secret scanning pattern configurations for an enterprise. Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/list-enterprise-pattern-configs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: push-protection parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-pattern-configuration" examples: default: "$ref": "#/components/examples/secret-scanning-pattern-configuration" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" patch: summary: Update enterprise pattern configurations description: |- Updates the secret scanning pattern configurations for an enterprise. Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/update-enterprise-pattern-configs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: push-protection parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: pattern_config_version: "$ref": "#/components/schemas/secret-scanning-row-version" provider_pattern_settings: type: array description: Pattern settings for provider patterns. items: type: object properties: token_type: type: string description: The ID of the pattern to configure. push_protection_setting: type: string description: Push protection setting to set for the pattern. enum: - not-set - disabled - enabled custom_pattern_settings: type: array description: Pattern settings for custom patterns. items: type: object properties: token_type: type: string description: The ID of the pattern to configure. custom_pattern_version: "$ref": "#/components/schemas/secret-scanning-row-version" push_protection_setting: type: string description: Push protection setting to set for the pattern. enum: - disabled - enabled examples: default: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_settings: - token_type: GITHUB_PERSONAL_ACCESS_TOKEN push_protection_setting: enabled custom_pattern_settings: - token_type: cp_2 custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K push_protection_setting: enabled responses: '200': description: Response content: application/json: schema: type: object properties: pattern_config_version: type: string description: The updated pattern configuration version. examples: default: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '422': "$ref": "#/components/responses/validation_failed" "/enterprises/{enterprise}/settings/billing/actions": get: summary: Get GitHub Actions billing for an enterprise description: |- Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". The authenticated user must be an enterprise admin. > [!NOTE] > This endpoint is available to enterprise customers who are using the legacy billing platform. operationId: billing/get-github-actions-billing-ghe tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-billing-usage" examples: default: "$ref": "#/components/examples/actions-billing-usage" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/advanced-security": get: summary: Get GitHub Advanced Security active committers for an enterprise description: |- Gets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager. Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository. The total number of repositories with committer information is tracked by the `total_count` field. tags: - billing operationId: billing/get-github-advanced-security-billing-ghe externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/advanced-security-product" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Success content: application/json: schema: "$ref": "#/components/schemas/advanced-security-active-committers" examples: default: "$ref": "#/components/examples/advanced-security-active-committers" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/budgets": get: summary: Get all budgets description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager. tags: - billing operationId: billing/get-all-budgets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': "$ref": "#/components/responses/get_all_budgets" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: true enabledForGitHubApps: false category: billing subcategory: enhanced-billing post: summary: Create a budget description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. tags: - billing operationId: billing/create-budget externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#create-a-budget parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object required: - budget_amount - prevent_further_usage - budget_alerting - budget_scope - budget_type properties: budget_amount: type: integer description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. prevent_further_usage: type: boolean description: Whether to prevent additional spending once the budget is exceeded budget_alerting: type: object required: - will_alert - alert_recipients properties: will_alert: type: boolean description: Whether alerts are enabled for this budget alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts budget_scope: type: string description: The scope of the budget enum: - enterprise - organization - repository - cost_center budget_entity_name: type: string description: The name of the entity to apply the budget to default: '' budget_type: type: string description: The type of pricing for the budget enum: - ProductPricing - SkuPricing budget_product_sku: type: string description: A single product or SKU that will be covered in the budget examples: create-budget: summary: Create budget example value: budget_amount: 200 prevent_further_usage: true budget_scope: enterprise budget_entity_name: '' budget_type: ProductPricing budget_product_sku: actions budget_alerting: will_alert: false alert_recipients: [] responses: '200': description: Budget created successfully content: application/json: schema: "$ref": "#/components/schemas/create-budget" examples: create-budget: "$ref": "#/components/examples/create-budget" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': description: Feature not enabled content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: feature-not-enabled: value: message: Not Found documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget '422': "$ref": "#/components/responses/validation_failed" '500': description: Internal server error content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: server-error: value: message: Unable to create budget. documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget x-github: githubCloudOnly: true enabledForGitHubApps: false category: billing subcategory: enhanced-billing "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager. tags: - billing operationId: billing/get-budget externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/budget" responses: '200': "$ref": "#/components/responses/budget" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: billing subcategory: enhanced-billing patch: summary: Update a budget description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. tags: - billing operationId: billing/update-budget externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget parameters: - name: enterprise in: path required: true schema: type: string description: The slug version of the enterprise name - name: budget_id in: path required: true schema: type: string description: The unique identifier of the budget requestBody: required: true content: application/json: schema: type: object properties: budget_amount: type: integer description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. prevent_further_usage: type: boolean description: Whether to prevent additional spending once the budget is exceeded budget_alerting: type: object properties: will_alert: type: boolean description: Whether alerts are enabled for this budget alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts budget_scope: type: string description: The scope of the budget enum: - enterprise - organization - repository - cost_center budget_entity_name: type: string description: The name of the entity to apply the budget to budget_type: type: string description: The type of pricing for the budget enum: - ProductPricing - SkuPricing budget_product_sku: type: string description: A single product or SKU that will be covered in the budget examples: update-budget: summary: Update budget example value: prevent_further_usage: false budget_amount: 10 budget_alerting: will_alert: false alert_recipients: [] responses: '200': description: Budget updated successfully content: application/json: schema: "$ref": "#/components/schemas/update-budget" examples: update-budget: "$ref": "#/components/examples/update-budget" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': description: Budget not found or feature not enabled content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: budget-not-found: value: message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found. documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget feature-not-enabled: value: message: Not Found documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget '422': "$ref": "#/components/responses/validation_failed" '500': description: Internal server error content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: server-error: value: message: Unable to retrieve budget. documentation_url: https://docs.github.com/rest/enterprise-admin/billing#update-a-budget '503': description: Service unavailable content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: server-error: value: message: Unable to update budget. documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget x-github: githubCloudOnly: true enabledForGitHubApps: false category: billing subcategory: enhanced-billing delete: summary: Delete a budget description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Deletes a budget by ID. The authenticated user must be an enterprise admin. tags: - billing operationId: billing/delete-budget externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/budget" responses: '200': "$ref": "#/components/responses/delete-budget" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: billing subcategory: enhanced-billing "/enterprises/{enterprise}/settings/billing/cost-centers": get: summary: Get all cost centers for an enterprise description: Gets a list of all the cost centers for an enterprise. tags: - billing operationId: billing/get-all-cost-centers externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/cost-center-state" responses: '200': "$ref": "#/components/responses/get_all_cost_centers" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing post: summary: Create a new cost center description: Creates a new cost center for an enterprise. The authenticated user must be an enterprise admin. tags: - billing operationId: billing/create-cost-center externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#create-a-new-cost-center parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object required: - name properties: name: type: string description: The name of the cost center (max length 255 characters) examples: example-1: summary: Example request to create a cost center value: name: Engineering Team responses: '200': description: Cost center created successfully content: application/json: schema: type: object properties: id: type: string description: Unique identifier for the cost center name: type: string description: Name of the cost center azure_subscription: type: string nullable: true description: Azure subscription ID associated with the cost center. Only present for cost centers linked to Azure subscriptions. state: type: string description: State of the cost center. enum: - active - deleted resources: type: array description: List of resources assigned to this cost center items: type: object properties: type: type: string description: Type of resource (User, Org, or Repo) name: type: string description: Name/login of the resource examples: example-1: summary: Example response for a created cost center value: id: abc123 name: Engineering Team resources: [] '400': description: Bad request content: application/json: examples: missing-name: summary: Missing name value: message: 'Bad request: name is required.' limit-reached: summary: Cost center limit reached value: message: This enterprise is already at the cost center limit of 1000 active cost centers. '409': description: Conflict content: application/json: examples: duplicate-name: summary: Duplicate name value: message: There's already a cost center created with that name. '500': description: Internal server error content: application/json: examples: internal-error: summary: Internal error value: message: An internal server error occurred. Please try again later. x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}": get: summary: Get a cost center by ID description: Gets a cost center by ID. The authenticated user must be an enterprise admin. tags: - billing operationId: billing/get-cost-center externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/cost-center" responses: '200': "$ref": "#/components/responses/get_cost_center" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing patch: summary: Update a cost center name description: Updates an existing cost center name. tags: - billing operationId: billing/update-cost-center externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#update-a-cost-center-name parameters: - name: enterprise in: path required: true schema: type: string description: The slug version of the enterprise name - name: cost_center_id in: path required: true schema: type: string description: The unique identifier of the cost center requestBody: required: true content: application/json: schema: type: object required: - name properties: name: type: string description: The new name for the cost center examples: update-cost-center: summary: Update cost center name example value: name: New Cost Center Name responses: '200': "$ref": "#/components/responses/cost_center" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing delete: summary: Delete a cost center description: Archieves a cost center by ID. The authenticated user must be an enterprise admin. tags: - billing operationId: billing/delete-cost-center externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/cost-center" responses: '200': "$ref": "#/components/responses/delete-cost-center" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource": post: summary: Add resources to a cost center description: |- Adds resources to a cost center. The usage for the resources will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. tags: - billing operationId: billing/add-resource-to-cost-center externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/cost-center" requestBody: required: true content: application/json: schema: type: object properties: users: description: The usernames of the users to add to the cost center. type: array items: type: string organizations: description: The organizations to add to the cost center. type: array items: type: string repositories: description: The repositories to add to the cost center. type: array items: type: string minProperties: 1 examples: default: value: users: - monalisa responses: '200': "$ref": "#/components/responses/add_resource_to_cost_center" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing delete: summary: Remove resources from a cost center description: |- Remove resources from a cost center. The usage for the resources will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. tags: - billing operationId: billing/remove-resource-from-cost-center externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/cost-center" requestBody: required: true content: application/json: schema: type: object properties: users: description: The usernames of the users to remove from the cost center. type: array items: type: string organizations: description: The organizations to remove from the cost center. type: array items: type: string repositories: description: The repositories to remove from the cost center. type: array items: type: string minProperties: 1 examples: default: value: users: - monalisa responses: '200': "$ref": "#/components/responses/remove_resource_from_cost_center" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/packages": get: summary: Get GitHub Packages billing for an enterprise description: |- Gets the free and paid storage used for GitHub Packages in gigabytes. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." The authenticated user must be an enterprise admin. > [!NOTE] > This endpoint is available to enterprise customers who are using the legacy billing platform. operationId: billing/get-github-packages-billing-ghe tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-packages-billing-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/packages-billing-usage" examples: default: "$ref": "#/components/examples/packages-billing-usage" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an enterprise description: |- Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-ghe externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month-default" - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-organization" - "$ref": "#/components/parameters/billing-usage-report-user" - "$ref": "#/components/parameters/billing-usage-report-model" - "$ref": "#/components/parameters/billing-usage-report-product" - name: cost_center_id description: The ID corresponding to a cost center. An ID of 'none' will target usage not associated to any cost center. in: query required: false schema: type: string responses: '200': "$ref": "#/components/responses/billing_premium_request_usage_report_ghe" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/shared-storage": get: summary: Get shared storage billing for an enterprise description: |- Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." The authenticated user must be an enterprise admin. > [!NOTE] > This endpoint is available to enterprise customers who are using the legacy billing platform. operationId: billing/get-shared-storage-billing-ghe tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-shared-storage-billing-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/combined-billing-usage" examples: default: "$ref": "#/components/examples/combined-billing-usage" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/usage": get: summary: Get billing usage report for an enterprise description: |- Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." tags: - billing operationId: billing/get-github-billing-usage-report-ghe externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month" - "$ref": "#/components/parameters/billing-usage-report-day" - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. in: query required: false schema: type: string responses: '200': "$ref": "#/components/responses/billing_usage_report" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/settings/billing/usage/summary": get: summary: Get billing usage summary for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise. **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-usage-summary-report-ghe externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month-default" - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-organization" - "$ref": "#/components/parameters/billing-usage-report-repository" - "$ref": "#/components/parameters/billing-usage-report-product" - "$ref": "#/components/parameters/billing-usage-report-sku" - "$ref": "#/components/parameters/billing-usage-report-cost-center-id" responses: '200': "$ref": "#/components/responses/billing_usage_summary_report_ghe" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: billing "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": get: summary: Get Copilot metrics for an enterprise team description: |- > [!NOTE] > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. > [!NOTE] > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-metrics-for-enterprise-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team-slug" - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. in: query required: false schema: type: string - name: until description: Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. in: query required: false schema: type: string - "$ref": "#/components/parameters/page" - name: per_page description: The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 100 responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/copilot-usage-metrics-day" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-for-day" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics "/enterprises/{enterprise}/teams": get: summary: List enterprise teams description: List all teams in the enterprise for the authenticated user tags: - enterprise-teams operationId: enterprise-teams/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/enterprise-team" examples: default: "$ref": "#/components/examples/enterprise-teams-items" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-teams post: summary: Create an enterprise team description: To create an enterprise team, the authenticated user must be an owner of the enterprise. tags: - enterprise-teams operationId: enterprise-teams/create externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#create-an-enterprise-team parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the team. description: nullable: true type: string description: A description of the team. sync_to_organizations: type: string description: | Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be set. enum: - all - disabled default: disabled organization_selection_type: type: string description: | Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. `all`: The team is assigned to all current and future organizations in the enterprise. enum: - disabled - selected - all default: disabled group_id: nullable: true type: string description: The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/enterprise-cloud@latest//rest/scim#list-provisioned-scim-groups-for-an-enterprise). required: - name examples: default: value: name: Justice League description: A great team. group_id: 62ab9291-fae2-468e-974b-7e45096d5021 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/enterprise-team" examples: default: "$ref": "#/components/examples/enterprise-teams-items" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-teams "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": get: summary: List members in an enterprise team description: Lists all team members in an enterprise team. tags: - enterprise-team-memberships operationId: enterprise-team-memberships/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": post: summary: Bulk add team members description: Add multiple team members to an enterprise team. tags: - enterprise-team-memberships operationId: enterprise-team-memberships/bulk-add externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" requestBody: required: true content: application/json: schema: type: object required: - usernames properties: usernames: type: array description: The GitHub user handles to add to the team. items: type: string description: The handle for the GitHub user account. examples: default: value: usernames: - monalisa - octocat responses: '200': description: Successfully added team members. content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": post: summary: Bulk remove team members description: Remove multiple team members from an enterprise team. tags: - enterprise-team-memberships operationId: enterprise-team-memberships/bulk-remove externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" requestBody: required: true content: application/json: schema: type: object required: - usernames properties: usernames: type: array description: The GitHub user handles to be removed from the team. items: type: string description: The handle for the GitHub user account. examples: default: value: usernames: - monalisa - octocat responses: '200': description: Successfully removed team members. content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": get: summary: Get enterprise team membership description: Returns whether the user is a member of the enterprise team. tags: - enterprise-team-memberships operationId: enterprise-team-memberships/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/username" responses: '200': description: User is a member of the enterprise team. content: application/json: schema: "$ref": "#/components/schemas/simple-user" examples: exampleKey1: "$ref": "#/components/examples/simple-user" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members put: summary: Add team member description: Add a team member to an enterprise team. tags: - enterprise-team-memberships operationId: enterprise-team-memberships/add externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/username" responses: '201': description: Successfully added team member content: application/json: schema: "$ref": "#/components/schemas/simple-user" examples: exampleKey1: "$ref": "#/components/examples/simple-user" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members delete: summary: Remove team membership description: Remove membership of a specific user from a particular team in an enterprise. tags: - enterprise-team-memberships operationId: enterprise-team-memberships/remove externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/username" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-members "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": get: summary: Get organization assignments description: Get all organizations assigned to an enterprise team tags: - enterprise-team-organizations operationId: enterprise-team-organizations/get-assignments externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: An array of organizations the team is assigned to content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-simple" examples: default: "$ref": "#/components/examples/organization-simple" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": post: summary: Add organization assignments description: Assign an enterprise team to multiple organizations. tags: - enterprise-team-organizations operationId: enterprise-team-organizations/bulk-add externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" requestBody: required: true content: application/json: schema: type: object required: - organization_slugs properties: organization_slugs: type: array description: Organization slug to assign the team to. items: type: string description: Organization slug to assign the team to examples: default: value: organization_slugs: - github responses: '200': description: Successfully assigned the enterprise team to organizations. content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-simple" examples: default: "$ref": "#/components/examples/organization-simple-items" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": post: summary: Remove organization assignments description: Unassign an enterprise team from multiple organizations. tags: - enterprise-team-organizations operationId: enterprise-team-organizations/bulk-remove externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" requestBody: required: true content: application/json: schema: type: object required: - organization_slugs properties: organization_slugs: type: array description: Organization slug to unassign the team from. items: type: string description: Organization slug to unassign the team from examples: default: value: organization_slugs: - github responses: '204': description: Successfully unassigned the enterprise team from organizations. x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": get: summary: Get organization assignment description: Check if an enterprise team is assigned to an organization tags: - enterprise-team-organizations operationId: enterprise-team-organizations/get-assignment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/org" responses: '200': description: The team is assigned to the organization content: application/json: schema: "$ref": "#/components/schemas/organization-simple" examples: default: "$ref": "#/components/examples/organization-simple" '404': description: The team is not assigned to the organization x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-organizations put: summary: Add an organization assignment description: Assign an enterprise team to an organization. tags: - enterprise-team-organizations operationId: enterprise-team-organizations/add externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/org" responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: schema: "$ref": "#/components/schemas/organization-simple" examples: default: "$ref": "#/components/examples/organization-simple" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-organizations delete: summary: Delete an organization assignment description: Unassign an enterprise team from an organization. tags: - enterprise-team-organizations operationId: enterprise-team-organizations/delete externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-team" - "$ref": "#/components/parameters/org" responses: '204': description: Successfully unassigned the enterprise team from the organization. x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-team-organizations "/enterprises/{enterprise}/teams/{team_slug}": get: summary: Get an enterprise team description: Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam Näme" would become `ent:my-team-name`. tags: - enterprise-teams operationId: enterprise-teams/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/team-slug" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/enterprise-team" examples: default: "$ref": "#/components/examples/enterprise-teams-items" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-teams patch: summary: Update an enterprise team description: To edit a team, the authenticated user must be an enterprise owner. tags: - enterprise-teams operationId: enterprise-teams/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/team-slug" requestBody: required: true content: application/json: schema: type: object properties: name: nullable: true type: string description: A new name for the team. description: nullable: true type: string description: A new description for the team. sync_to_organizations: type: string description: | Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be changed. enum: - all - disabled default: disabled organization_selection_type: type: string description: | Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). `all`: The team is assigned to all current and future organizations in the enterprise. enum: - disabled - selected - all default: disabled group_id: nullable: true type: string description: The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. examples: default: value: name: Justice League description: A great team. group_id: 62ab9291-fae2-468e-974b-7e45096d5021 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/enterprise-team" examples: default: "$ref": "#/components/examples/enterprise-teams-items" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-teams delete: summary: Delete an enterprise team description: |- To delete an enterprise team, the authenticated user must be an enterprise owner. If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. tags: - enterprise-teams operationId: enterprise-teams/delete externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/team-slug" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: enterprise-teams subcategory: enterprise-teams "/enterprises/{enterprise}/{security_product}/{enablement}": post: summary: Enable or disable a security feature description: |- > [!WARNING] > **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). Enables or disables the specified security feature for all repositories in an enterprise. The authenticated user must be an administrator of the enterprise to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - enterprise-admin operationId: secret-scanning/post-security-product-enablement-for-enterprise externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/enterprise-security-product" - "$ref": "#/components/parameters/enterprise-security-product-enablement" responses: '204': description: Action started '422': description: The action could not be taken due to an in progress enablement, or a policy is preventing enablement '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false category: enterprise-admin subcategory: code-security-and-analysis deprecationDate: '2024-09-27' removalDate: '2025-09-27' deprecated: true "/events": get: summary: List public events description: |- > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events parameters: - "$ref": "#/components/parameters/public-events-per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: default: "$ref": "#/components/examples/public-events-items" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/feeds": get: summary: Get feeds description: |- 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. * **Timeline**: The GitHub Enterprise Cloud global public timeline * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * **Current user public**: The public timeline for the authenticated user * **Current user**: The private timeline for the authenticated user * **Current user actor**: The private timeline for activity created by the authenticated user * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. 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](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." > [!NOTE] > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. tags: - activity operationId: activity/get-feeds externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/feeds#get-feeds parameters: [] responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/feed" examples: default: "$ref": "#/components/examples/feed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: feeds "/gists": get: summary: List gists for the authenticated user description: 'Lists the authenticated user''s gists or if called anonymously, this endpoint returns all public gists:' tags: - gists operationId: gists/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/base-gist" examples: default: "$ref": "#/components/examples/base-gist-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists post: summary: Create a gist description: |- Allows you to add a new gist with one or more files. > [!NOTE] > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. operationId: gists/create tags: - gists externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#create-a-gist parameters: [] requestBody: required: true content: application/json: schema: properties: description: description: Description of the gist example: Example Ruby script type: string files: description: Names and content for the files that make up the gist example: hello.rb: content: puts "Hello, World!" type: object additionalProperties: type: object properties: content: description: Content of the file readOnly: false type: string required: - content public: oneOf: - description: Flag indicating whether the gist is public example: true type: boolean default: false - type: string example: 'true' default: 'false' enum: - 'true' - 'false' required: - files type: object examples: default: summary: Creating a gist value: description: Example of a gist public: false files: README.md: content: Hello World responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/gist-simple" examples: default: "$ref": "#/components/examples/gist" headers: Location: example: https://api.github.com/gists/aa5a315d61ae9438b18d schema: type: string '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gists/public": get: summary: List public gists description: |- List public gists sorted by most recently updated to least recently updated. Note: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. tags: - gists operationId: gists/list-public externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/base-gist" examples: default: "$ref": "#/components/examples/base-gist-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gists/starred": get: summary: List starred gists description: 'List the authenticated user''s starred gists:' tags: - gists operationId: gists/list-starred externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/base-gist" examples: default: "$ref": "#/components/examples/base-gist-items" headers: Link: "$ref": "#/components/headers/link" '401': "$ref": "#/components/responses/requires_authentication" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gists/{gist_id}": get: summary: Get a gist description: |- Gets a specified gist. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - "$ref": "#/components/parameters/gist-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/gist-simple" examples: default: "$ref": "#/components/examples/gist" '403': "$ref": "#/components/responses/forbidden_gist" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists patch: summary: Update a gist description: |- Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. At least one of `description` or `files` is required. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - "$ref": "#/components/parameters/gist-id" requestBody: required: true content: application/json: schema: properties: description: description: The description of the gist. example: Example Ruby script type: string files: description: |- The gist files to be updated, renamed, or deleted. Each `key` must match the current filename (including extension) of the targeted gist file. For example: `hello.py`. To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be deleted if the specified object does not contain at least one of `content` or `filename`. example: hello.rb: content: blah filename: goodbye.rb type: object additionalProperties: type: object nullable: true properties: content: description: The new content of the file. type: string filename: description: The new filename for the file. type: string nullable: true type: object nullable: true examples: updateGist: summary: Updating a gist value: description: An updated gist description files: README.md: content: Hello World from GitHub deleteFile: summary: Deleting a gist file value: files: hello.py: renameFile: summary: Renaming a gist file value: files: hello.py: filename: goodbye.py responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/gist-simple" examples: updateGist: "$ref": "#/components/examples/gist" deleteFile: "$ref": "#/components/examples/delete-gist-file" renameFile: "$ref": "#/components/examples/rename-gist-file" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists delete: summary: Delete a gist description: '' tags: - gists operationId: gists/delete externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - "$ref": "#/components/parameters/gist-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gists/{gist_id}/comments": get: summary: List gist comments description: |- Lists the comments on a gist. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/list-comments externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - "$ref": "#/components/parameters/gist-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/gist-comment" examples: default: "$ref": "#/components/examples/gist-comment-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: comments post: summary: Create a gist comment description: |- Creates a comment on a gist. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/create-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - "$ref": "#/components/parameters/gist-id" requestBody: required: true content: application/json: schema: properties: body: description: The comment text. type: string maxLength: 65535 example: Body of the attachment type: object required: - body examples: default: summary: Creating a comment in a gist value: body: This is a comment to a gist responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/gist-comment" examples: default: "$ref": "#/components/examples/gist-comment" headers: Location: example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 schema: type: string '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: comments "/gists/{gist_id}/comments/{comment_id}": get: summary: Get a gist comment description: |- Gets a comment on a gist. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - "$ref": "#/components/parameters/gist-id" - "$ref": "#/components/parameters/comment-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/gist-comment" examples: default: "$ref": "#/components/examples/gist-comment" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden_gist" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: comments patch: summary: Update a gist comment description: |- Updates a comment on a gist. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/update-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - "$ref": "#/components/parameters/gist-id" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: properties: body: description: The comment text. type: string maxLength: 65535 example: Body of the attachment type: object required: - body examples: default: summary: Updating a comment in a gist value: body: This is an update to a comment in a gist responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/gist-comment" examples: default: "$ref": "#/components/examples/gist-comment" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: comments delete: summary: Delete a gist comment description: '' tags: - gists operationId: gists/delete-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - "$ref": "#/components/parameters/gist-id" - "$ref": "#/components/parameters/comment-id" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: comments "/gists/{gist_id}/commits": get: summary: List gist commits description: '' tags: - gists operationId: gists/list-commits externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - "$ref": "#/components/parameters/gist-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/gist-commit" examples: default: "$ref": "#/components/examples/gist-commit-items" headers: Link: example: ; rel="next" schema: type: string '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gists/{gist_id}/forks": get: summary: List gist forks description: '' tags: - gists operationId: gists/list-forks externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - "$ref": "#/components/parameters/gist-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/gist-simple" examples: default: "$ref": "#/components/examples/gist-fork-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists post: summary: Fork a gist description: '' tags: - gists operationId: gists/fork externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - "$ref": "#/components/parameters/gist-id" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/base-gist" examples: default: "$ref": "#/components/examples/base-gist" headers: Location: example: https://api.github.com/gists/aa5a315d61ae9438b18d schema: type: string '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gists/{gist_id}/star": get: summary: Check if a gist is starred description: '' tags: - gists operationId: gists/check-is-starred externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - "$ref": "#/components/parameters/gist-id" responses: '204': description: Response if gist is starred '404': description: Not Found if gist is not starred content: application/json: schema: type: object properties: {} additionalProperties: false '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists put: summary: Star a gist description: Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." tags: - gists operationId: gists/star externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - "$ref": "#/components/parameters/gist-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists delete: summary: Unstar a gist description: '' tags: - gists operationId: gists/unstar externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - "$ref": "#/components/parameters/gist-id" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gists/{gist_id}/{sha}": get: summary: Get a gist revision description: |- Gets a specified gist revision. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get-revision externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - "$ref": "#/components/parameters/gist-id" - name: sha in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/gist-simple" examples: default: "$ref": "#/components/examples/gist" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/gitignore/templates": get: summary: Get all gitignore templates description: List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user). operationId: gitignore/get-all-templates tags: - gitignore externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-all-gitignore-templates parameters: [] responses: '200': description: Response content: application/json: schema: type: array items: type: string examples: default: value: - Actionscript - Android - AppceleratorTitanium - Autotools - Bancha - C - C++ '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: gitignore subcategory: gitignore "/gitignore/templates/{name}": get: summary: Get a gitignore template description: |- Get the content of a gitignore template. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. operationId: gitignore/get-template tags: - gitignore externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gitignore/gitignore#get-a-gitignore-template parameters: - name: name in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/gitignore-template" examples: default: "$ref": "#/components/examples/gitignore-template" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: gitignore subcategory: gitignore "/installation/repositories": get: summary: List repositories accessible to the app installation description: List repositories that an app installation can access. tags: - apps operationId: apps/list-repos-accessible-to-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-app-installation parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/repository" repository_selection: type: string example: selected examples: default: "$ref": "#/components/examples/repository-paginated-2" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" '304': "$ref": "#/components/responses/not_modified" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: installations "/installation/token": delete: summary: Revoke an installation access token description: |- Revokes the installation token you're using to authenticate as an installation and access this endpoint. 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 "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. tags: - apps operationId: apps/revoke-installation-access-token externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#revoke-an-installation-access-token parameters: [] responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: installations "/issues": get: summary: List issues assigned to the authenticated user description: |- List issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not necessarily assigned to you. > [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - "$ref": "#/components/parameters/labels" - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/since" - name: collab in: query required: false schema: type: boolean - name: orgs in: query required: false schema: type: boolean - name: owned in: query required: false schema: type: boolean - name: pulls in: query required: false schema: type: boolean - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue-with-repo-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues "/licenses": get: summary: Get all commonly used licenses description: Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get-all-commonly-used externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-all-commonly-used-licenses parameters: - name: featured in: query required: false schema: type: boolean - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/license-simple" examples: default: "$ref": "#/components/examples/license-simple-items" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: licenses subcategory: licenses "/licenses/{license}": get: summary: Get a license description: Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - licenses operationId: licenses/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-a-license parameters: - name: license in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/license" examples: default: "$ref": "#/components/examples/license" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: licenses subcategory: licenses "/markdown": post: summary: Render a Markdown document description: Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. operationId: markdown/render tags: - markdown externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document parameters: [] requestBody: required: true content: application/json: schema: properties: text: description: The Markdown text to render in HTML. type: string mode: description: The rendering mode. enum: - markdown - gfm default: markdown example: markdown type: string context: description: The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. type: string required: - text type: object examples: default: summary: Rendering markdown value: text: Hello **world** responses: '200': description: Response headers: Content-Type: "$ref": "#/components/headers/content-type" Content-Length: example: '279' schema: type: string X-CommonMarker-Version: "$ref": "#/components/headers/x-common-marker-version" content: text/html: schema: type: string examples: default: summary: Example response value: "

Hello world

" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: markdown subcategory: markdown "/markdown/raw": post: summary: Render a Markdown document in raw mode description: You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. operationId: markdown/render-raw tags: - markdown externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/markdown/markdown#render-a-markdown-document-in-raw-mode parameters: [] requestBody: required: false content: text/plain: schema: type: string examples: default: value: text: Hello **world** text/x-markdown: schema: type: string examples: default: summary: Rendering markdown value: text: Hello **world** responses: '200': description: Response headers: X-CommonMarker-Version: "$ref": "#/components/headers/x-common-marker-version" content: text/html: schema: type: string examples: default: summary: Example response value: "

Hello world

" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: markdown subcategory: markdown "/marketplace_listing/accounts/{account_id}": get: summary: Get a subscription plan for an account description: |- Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/get-subscription-plan-for-account externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - "$ref": "#/components/parameters/account-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/marketplace-purchase" examples: default: "$ref": "#/components/examples/marketplace-purchase" '404': description: Not Found when the account has not purchased the listing content: application/json: schema: "$ref": "#/components/schemas/basic-error" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/marketplace_listing/plans": get: summary: List plans description: |- Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-plans externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/marketplace-listing-plan" examples: default: "$ref": "#/components/examples/marketplace-listing-plan-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/marketplace_listing/plans/{plan_id}/accounts": get: summary: List accounts for a plan description: |- Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-accounts-for-plan externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - "$ref": "#/components/parameters/plan-id" - "$ref": "#/components/parameters/sort" - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/marketplace-purchase" examples: default: "$ref": "#/components/examples/marketplace-purchase-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/marketplace_listing/stubbed/accounts/{account_id}": get: summary: Get a subscription plan for an account (stubbed) description: |- Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/get-subscription-plan-for-account-stubbed externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - "$ref": "#/components/parameters/account-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/marketplace-purchase" examples: default: "$ref": "#/components/examples/marketplace-purchase" '404': description: Not Found when the account has not purchased the listing '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/marketplace_listing/stubbed/plans": get: summary: List plans (stubbed) description: |- Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-plans-stubbed externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-plans-stubbed parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/marketplace-listing-plan" examples: default: "$ref": "#/components/examples/marketplace-listing-plan-items" headers: Link: "$ref": "#/components/headers/link" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/marketplace_listing/stubbed/plans/{plan_id}/accounts": get: summary: List accounts for a plan (stubbed) description: |- Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. tags: - apps operationId: apps/list-accounts-for-plan-stubbed externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - "$ref": "#/components/parameters/plan-id" - "$ref": "#/components/parameters/sort" - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/marketplace-purchase" examples: default: "$ref": "#/components/examples/marketplace-purchase-items" headers: Link: "$ref": "#/components/headers/link" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/meta": get: summary: Get GitHub Enterprise Cloud meta information description: |- Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/)." The API's response also includes a list of GitHub's domain names. The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. > [!NOTE] > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. tags: - meta operationId: meta/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-apiname-meta-information parameters: [] responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-overview" examples: default: "$ref": "#/components/examples/api-overview" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: meta subcategory: meta "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories description: |- > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: default: "$ref": "#/components/examples/public-repo-events-items" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '304': "$ref": "#/components/responses/not_modified" '301': "$ref": "#/components/responses/moved_permanently" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/notifications": get: summary: List notifications for the authenticated user description: List all notifications for the current user, sorted by most recently updated. tags: - activity operationId: activity/list-notifications-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/all" - "$ref": "#/components/parameters/participating" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/before" - "$ref": "#/components/parameters/page" - name: per_page description: The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 50 responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/thread" examples: default: "$ref": "#/components/examples/thread-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications put: summary: Mark notifications as read description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity operationId: activity/mark-notifications-as-read externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-notifications-as-read parameters: [] requestBody: required: false content: application/json: schema: type: object properties: last_read_at: description: 'Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.' type: string format: date-time read: description: Whether the notification has been read. type: boolean examples: default: value: last_read_at: '2022-06-10T00:00:00Z' read: true responses: '202': description: Response content: application/json: schema: type: object properties: message: type: string examples: default: "$ref": "#/components/examples/notifications-mark-read" '205': description: Reset Content '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications "/notifications/threads/{thread_id}": get: summary: Get a thread description: Gets information about a notification thread. tags: - activity operationId: activity/get-thread externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - "$ref": "#/components/parameters/thread-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/thread" examples: default: "$ref": "#/components/examples/thread" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications patch: summary: Mark a thread as read description: 'Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Cloud: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-read externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - "$ref": "#/components/parameters/thread-id" responses: '205': description: Reset Content '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications delete: summary: Mark a thread as done description: 'Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.' tags: - activity operationId: activity/mark-thread-as-done externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - "$ref": "#/components/parameters/thread-id" responses: '204': description: No content x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications "/notifications/threads/{thread_id}/subscription": get: summary: Get a thread subscription for the authenticated user description: |- This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription). Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. tags: - activity operationId: activity/get-thread-subscription-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/thread-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/thread-subscription" examples: default: "$ref": "#/components/examples/thread-subscription" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications put: summary: Set a thread subscription description: |- If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint. tags: - activity operationId: activity/set-thread-subscription externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - "$ref": "#/components/parameters/thread-id" requestBody: required: false content: application/json: schema: properties: ignored: description: Whether to block all notifications from a thread. default: false type: boolean type: object examples: default: value: ignored: false responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/thread-subscription" examples: default: "$ref": "#/components/examples/thread-subscription" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications delete: summary: Delete a thread subscription description: Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. tags: - activity operationId: activity/delete-thread-subscription externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - "$ref": "#/components/parameters/thread-id" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications "/octocat": get: summary: Get Octocat description: Get the octocat as ASCII art tags: - meta operationId: meta/get-octocat parameters: - name: s in: query description: The words to show in Octocat's speech bubble schema: type: string required: false responses: '200': description: Response content: application/octocat-stream: schema: type: string examples: default: "$ref": "#/components/examples/octocat" externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-octocat x-github: githubCloudOnly: false enabledForGitHubApps: true category: meta subcategory: meta "/organizations": get: summary: List organizations description: |- Lists all organizations, in the order that they were created. > [!NOTE] > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. tags: - orgs operationId: orgs/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations parameters: - "$ref": "#/components/parameters/since-org" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-simple" examples: default: "$ref": "#/components/examples/organization-simple-items" headers: Link: example: ; rel="next" schema: type: string '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs "/organizations/{organization_id}/custom_roles": get: summary: Closing down - List custom repository roles in an organization description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/list-custom-roles externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization parameters: - name: organization_id description: The unique identifier of the organization. in: path required: true schema: type: string responses: '200': description: Response - list of custom role names content: application/json: schema: type: object properties: total_count: description: The number of custom roles in this organization example: 3 type: integer custom_roles: type: array items: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-example" x-github: githubCloudOnly: true enabledForGitHubApps: true removalDate: '2025-02-15' deprecationDate: '2023-02-15' category: orgs subcategory: custom-roles deprecated: true "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization description: |- Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. > [!NOTE] > This operation supports both server-to-server and user-to-server access. Unauthorized users will not see the existence of this endpoint. tags: - dependabot operationId: dependabot/repository-access-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - "$ref": "#/components/parameters/org" - name: page in: query description: The page number of results to fetch. required: false schema: type: integer minimum: 1 default: 1 - name: per_page in: query description: Number of results per page. required: false schema: type: integer minimum: 1 maximum: 100 default: 30 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependabot-repository-access-details" examples: default: "$ref": "#/components/examples/dependabot-repository-access-details" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: repository-access patch: summary: Updates Dependabot's repository access list for an organization description: |- Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. > [!NOTE] > This operation supports both server-to-server and user-to-server access. Unauthorized users will not see the existence of this endpoint. **Example request body:** ```json { "repository_ids_to_add": [123, 456], "repository_ids_to_remove": [789] } ``` tags: - dependabot operationId: dependabot/update-repository-access-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: repository_ids_to_add: type: array items: type: integer description: List of repository IDs to add. repository_ids_to_remove: type: array items: type: integer description: List of repository IDs to remove. example: repository_ids_to_add: - 123 - 456 repository_ids_to_remove: - 789 examples: '204': summary: Example with a 'succeeded' status. add-example: summary: Add repositories value: repository_ids_to_add: - 123 - 456 remove-example: summary: Remove repositories value: repository_ids_to_remove: - 789 responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: repository-access "/organizations/{org}/dependabot/repository-access/default-level": put: summary: Set the default repository access level for Dependabot description: |- Sets the default level of repository access Dependabot will have while performing an update. Available values are: - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. Unauthorized users will not see the existence of this endpoint. This operation supports both server-to-server and user-to-server access. tags: - dependabot operationId: dependabot/set-repository-access-default-level externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: default_level: type: string description: The default repository access level for Dependabot updates. enum: - public - internal example: internal required: - default_level examples: '204': summary: Example with a 'succeeded' status. value: default_level: public responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: repository-access "/organizations/{org}/org-properties/values": get: summary: Get all custom property values for an organization description: |- Gets all custom property values that are set for an organization. The organization must belong to an enterprise. Access requirements: - Organization admins - OAuth tokens and personal access tokens (classic) with the `read:org` scope - Actors with the organization-level "read custom properties for an organization" fine-grained permission or above tags: - orgs operationId: orgs/custom-properties-for-orgs-get-organization-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/custom-property-value" examples: default: "$ref": "#/components/examples/custom-property-values" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs patch: summary: Create or update custom property values for an organization description: |- Create new or update existing custom property values for an organization. To remove a custom property value from an organization, set the property value to `null`. The organization must belong to an enterprise. Access requirements: - Organization admins - OAuth tokens and personal access tokens (classic) with the `admin:org` scope - Actors with the organization-level "edit custom properties for an organization" fine-grained permission tags: - orgs operationId: orgs/custom-properties-for-orgs-create-or-update-organization-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: properties: type: array description: A list of custom property names and associated values to apply to the organization. items: "$ref": "#/components/schemas/custom-property-value" required: - properties examples: default: "$ref": "#/components/examples/create-or-update-custom-properties-values" responses: '204': description: No Content when custom property values are successfully created or updated '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs "/organizations/{org}/settings/billing/budgets": get: summary: Get all budgets for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. tags: - billing operationId: billing/get-all-budgets-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': "$ref": "#/components/responses/get_all_budgets" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/organizations/{org}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets a budget by ID. The authenticated user must be an organization admin or billing manager. tags: - billing operationId: billing/get-budget-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/budget" responses: '200': "$ref": "#/components/responses/budget" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing patch: summary: Update a budget for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. tags: - billing operationId: billing/update-budget-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/budget" requestBody: required: true content: application/json: schema: type: object properties: budget_amount: type: integer description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. prevent_further_usage: type: boolean description: Whether to prevent additional spending once the budget is exceeded budget_alerting: type: object properties: will_alert: type: boolean description: Whether alerts are enabled for this budget alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts budget_scope: type: string description: The scope of the budget enum: - enterprise - organization - repository - cost_center budget_entity_name: type: string description: The name of the entity to apply the budget to budget_type: type: string description: The type of pricing for the budget enum: - ProductPricing - SkuPricing budget_product_sku: type: string description: A single product or SKU that will be covered in the budget examples: update-budget: summary: Update budget example value: prevent_further_usage: false budget_amount: 10 budget_alerting: will_alert: false alert_recipients: [] responses: '200': description: Budget updated successfully content: application/json: schema: type: object properties: message: type: string example: Budget successfully updated. budget: type: object properties: id: type: string description: ID of the budget. budget_amount: type: number format: float description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. prevent_further_usage: type: boolean description: Whether to prevent additional spending once the budget is exceeded budget_alerting: type: object required: - will_alert - alert_recipients properties: will_alert: type: boolean description: Whether alerts are enabled for this budget alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts budget_scope: type: string description: The scope of the budget enum: - enterprise - organization - repository - cost_center budget_entity_name: type: string description: The name of the entity to apply the budget to default: '' budget_type: type: string description: The type of pricing for the budget enum: - ProductPricing - SkuPricing budget_product_sku: type: string description: A single product or SKU that will be covered in the budget examples: update-budget: value: message: Budget successfully updated. id: 550e8400-e29b-41d4-a716-446655440000 '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': description: Budget not found or feature not enabled content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: budget-not-found: value: message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found. documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget feature-not-enabled: value: message: Not Found documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget '422': "$ref": "#/components/responses/validation_failed" '500': description: Internal server error content: application/json: schema: "$ref": "#/components/schemas/basic-error" examples: server-error: value: message: Unable to update budget. documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget x-github: githubCloudOnly: false enabledForGitHubApps: false category: billing subcategory: enhanced-billing delete: summary: Delete a budget for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. tags: - billing operationId: billing/delete-budget-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/budget" responses: '200': "$ref": "#/components/responses/delete-budget" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization description: |- Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month-default" - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-user" - "$ref": "#/components/parameters/billing-usage-report-model" - "$ref": "#/components/parameters/billing-usage-report-product" responses: '200': "$ref": "#/components/responses/billing_premium_request_usage_report_org" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage": get: summary: Get billing usage report for an organization description: |- Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform)." tags: - billing operationId: billing/get-github-billing-usage-report-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month" - "$ref": "#/components/parameters/billing-usage-report-day" responses: '200': "$ref": "#/components/responses/billing_usage_report_org" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month-default" - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-repository" - "$ref": "#/components/parameters/billing-usage-report-product" - "$ref": "#/components/parameters/billing-usage-report-sku" responses: '200': "$ref": "#/components/responses/billing_usage_summary_report_org" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/orgs/{org}": get: summary: Get an organization description: |- Gets information about an organization. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/). To see the full details about an organization, the authenticated user must be an organization owner. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. tags: - orgs operationId: orgs/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-full" examples: default-response: "$ref": "#/components/examples/organization-full" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs patch: summary: Update an organization description: |- > [!WARNING] > **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). > [!WARNING] > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). Updates the organization's profile and member privileges. The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: false content: application/json: schema: type: object properties: billing_email: type: string description: Billing email address. This address is not publicized. company: type: string description: The company name. email: type: string description: The publicly visible email address. twitter_username: type: string description: The Twitter username of the company. location: type: string description: The location. name: type: string description: The shorthand name of the company. description: type: string description: The description of the company. The maximum size is 160 characters. has_organization_projects: type: boolean description: Whether an organization can use organization projects. has_repository_projects: type: boolean description: Whether repositories that belong to the organization can use repository projects. default_repository_permission: type: string description: Default permission level members have for organization repositories. enum: - read - write - admin - none default: read members_can_create_repositories: type: boolean description: Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. default: true members_can_create_internal_repositories: type: boolean description: Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_private_repositories: type: boolean description: Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_can_create_public_repositories: type: boolean description: Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. members_allowed_repository_creation_type: type: string description: "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details." enum: - all - private - none members_can_create_pages: type: boolean description: Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted. default: true members_can_create_public_pages: type: boolean description: Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted. default: true members_can_create_private_pages: type: boolean description: Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted. default: true members_can_fork_private_repositories: type: boolean description: Whether organization members can fork private organization repositories. default: false web_commit_signoff_required: type: boolean description: Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface. default: false blog: type: string example: '"http://github.blog"' advanced_security_enabled_for_new_repositories: type: boolean description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. deprecated: true secret_scanning_push_protection_custom_link_enabled: type: boolean description: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. secret_scanning_push_protection_custom_link: type: string description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. secret_scanning_validity_checks_enabled: type: boolean description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true deploy_keys_enabled_for_repositories: type: boolean description: Controls whether or not deploy keys may be added and used for repositories in the organization. examples: default: value: billing_email: mona@github.com company: GitHub email: mona@github.com twitter_username: github location: San Francisco name: github description: GitHub, the company. default_repository_permission: read members_can_create_repositories: true members_allowed_repository_creation_type: all responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-full" examples: default: "$ref": "#/components/examples/organization-full" '422': description: Validation failed content: application/json: schema: oneOf: - "$ref": "#/components/schemas/validation-error" - "$ref": "#/components/schemas/validation-error-simple" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs delete: summary: Delete an organization description: |- Deletes an organization and all its repositories. The organization login will be unavailable for 90 days after deletion. Please review the Terms of Service regarding account deletion before using this endpoint: https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service operationId: orgs/delete tags: - orgs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '202': "$ref": "#/components/responses/accepted" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for an organization description: |- Gets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-cache-usage-org-enterprise" examples: default: "$ref": "#/components/examples/actions-cache-usage-org-enterprise" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache "/orgs/{org}/actions/cache/usage-by-repository": get: summary: List repositories with GitHub Actions cache usage for an organization description: |- Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage-by-repo-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repository_cache_usages properties: total_count: type: integer repository_cache_usages: type: array items: "$ref": "#/components/schemas/actions-cache-usage-by-repository" examples: default: "$ref": "#/components/examples/org-actions-cache-usage-by-repo" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache "/orgs/{org}/actions/hosted-runners": get: summary: List GitHub-hosted runners for an organization description: |- Lists all GitHub-hosted runners configured in an organization. OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. tags: - actions operationId: actions/list-hosted-runners-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runners properties: total_count: type: integer runners: type: array items: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners post: summary: Create a GitHub-hosted runner for an organization description: |- Creates a GitHub-hosted runner for an organization. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. operationId: actions/create-hosted-runner-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. type: string image: description: The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. type: object properties: id: description: The unique identifier of the runner image. type: string source: description: The source of the runner image. type: string enum: - github - partner - custom version: description: The version of the runner image to deploy. This is relevant only for runners using custom images. type: string nullable: true size: description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` type: string runner_group_id: description: The existing runner group to add this runner to. type: integer maximum_runners: description: The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. type: integer enable_static_ip: description: Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean image_gen: description: Whether this runner should be used to generate custom images. type: boolean default: false required: - name - image - size - runner_group_id examples: default: value: name: My Hosted runner image: id: ubuntu-latest source: github runner_group_id: 1 size: 4-core maximum_runners: 50 enable_static_ip: false responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/custom": get: summary: List custom images for an organization description: |- List custom images for an organization. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. tags: - actions operationId: actions/list-custom-images-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - images properties: total_count: type: integer images: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-custom-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": get: summary: Get a custom image definition for GitHub Actions Hosted Runners description: |- Get a custom image definition for GitHub Actions Hosted Runners. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. tags: - actions operationId: actions/get-custom-image-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/actions-custom-image-definition-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner-custom-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners delete: summary: Delete a custom image from the organization description: |- Delete a custom image from the organization. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. tags: - actions operationId: actions/delete-custom-image-from-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/actions-custom-image-definition-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": get: summary: List image versions of a custom image for an organization description: |- List image versions of a custom image for an organization. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. tags: - actions operationId: actions/list-custom-image-versions-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - "$ref": "#/components/parameters/actions-custom-image-definition-id" - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - image_versions properties: total_count: type: integer image_versions: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": get: summary: Get an image version of a custom image for GitHub Actions Hosted Runners description: |- Get an image version of a custom image for GitHub Actions Hosted Runners. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. tags: - actions operationId: actions/get-custom-image-version-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/actions-custom-image-definition-id" - "$ref": "#/components/parameters/actions-custom-image-version" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" examples: default: "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners delete: summary: Delete an image version of custom image from the organization description: |- Delete an image version of custom image from the organization. OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. tags: - actions operationId: actions/delete-custom-image-version-from-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/actions-custom-image-definition-id" - "$ref": "#/components/parameters/actions-custom-image-version" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization description: Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. operationId: actions/get-hosted-runners-github-owned-images-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - images properties: total_count: type: integer images: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/partner": get: summary: Get partner images for GitHub-hosted runners in an organization description: Get the list of partner images available for GitHub-hosted runners for an organization. operationId: actions/get-hosted-runners-partner-images-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - images properties: total_count: type: integer images: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/limits": get: summary: Get limits on GitHub-hosted runners for an organization description: Get the GitHub-hosted runners limits for an organization. operationId: actions/get-hosted-runners-limits-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner-limits" examples: default: "$ref": "#/components/examples/actions-hosted-runner-limits-default" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/machine-sizes": get: summary: Get GitHub-hosted runners machine specs for an organization description: Get the list of machine specs available for GitHub-hosted runners for an organization. operationId: actions/get-hosted-runners-machine-specs-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - machine_specs properties: total_count: type: integer machine_specs: type: array items: "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" examples: default: "$ref": "#/components/examples/actions-hosted-runner-machine-spec" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/platforms": get: summary: Get platforms for GitHub-hosted runners in an organization description: Get the list of platforms available for GitHub-hosted runners for an organization. operationId: actions/get-hosted-runners-platforms-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - platforms properties: total_count: type: integer platforms: type: array items: type: string examples: default: value: total_count: 1 platforms: - linux-x64 - win-x64 x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": get: summary: Get a GitHub-hosted runner for an organization description: |- Gets a GitHub-hosted runner configured in an organization. OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. tags: - actions operationId: actions/get-hosted-runner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hosted-runner-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: hosted-runners patch: summary: Update a GitHub-hosted runner for an organization description: |- Updates a GitHub-hosted runner for an organization. OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. operationId: actions/update-hosted-runner-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hosted-runner-id" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. type: string runner_group_id: description: The existing runner group to add this runner to. type: integer maximum_runners: description: The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. type: integer enable_static_ip: description: Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean image_version: description: The version of the runner image to deploy. This is relevant only for runners using custom images. type: string nullable: true examples: default: value: name: My larger runner runner_group_id: 1 maximum_runners: 50 enable_static_ip: false responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: hosted-runners delete: summary: Delete a GitHub-hosted runner for an organization description: Deletes a GitHub-hosted runner for an organization. operationId: actions/delete-hosted-runner-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hosted-runner-id" responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner" x-github: githubCloudOnly: false enabledForGitHubApps: false category: actions subcategory: hosted-runners "/orgs/{org}/actions/oidc/customization/sub": get: summary: Get the customization template for an OIDC subject claim for an organization description: |- Gets the customization template for an OpenID Connect (OIDC) subject claim. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - oidc operationId: oidc/get-oidc-custom-sub-template-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: schema: "$ref": "#/components/schemas/oidc-custom-sub" examples: default: "$ref": "#/components/examples/oidc-custom-sub" x-github: enabledForGitHubApps: true category: actions subcategory: oidc put: summary: Set the customization template for an OIDC subject claim for an organization description: |- Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - oidc operationId: oidc/update-oidc-custom-sub-template-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/oidc-custom-sub" examples: default: "$ref": "#/components/examples/oidc-custom-sub" responses: '201': description: Empty response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: enabledForGitHubApps: true previews: [] category: actions subcategory: oidc "/orgs/{org}/actions/permissions": get: summary: Get GitHub Actions permissions for an organization description: |- Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/get-github-actions-permissions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-organization-permissions" examples: default: "$ref": "#/components/examples/actions-organization-permissions" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions put: summary: Set GitHub Actions permissions for an organization description: |- Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-github-actions-permissions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: enabled_repositories: "$ref": "#/components/schemas/enabled-repositories" allowed_actions: "$ref": "#/components/schemas/allowed-actions" sha_pinning_required: "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_repositories examples: default: value: enabled_repositories: all allowed_actions: selected sha_pinning_required: true x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions "/orgs/{org}/actions/permissions/artifact-and-log-retention": get: summary: Get artifact and log retention settings for an organization description: |- Gets artifact and log retention settings for an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/get-artifact-and-log-retention-settings-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" examples: response: summary: Example response value: days: 90 maximum_allowed_days: 365 '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set artifact and log retention settings for an organization description: |- Sets artifact and log retention settings for an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/set-artifact-and-log-retention-settings-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-artifact-and-log-retention" examples: application/json: value: days: 100 responses: '204': description: No content '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '422': "$ref": "#/components/responses/validation_failed" x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": get: summary: Get fork PR contributor approval permissions for an organization description: |- Gets the fork PR contributor approval policy for an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/get-fork-pr-contributor-approval-permissions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: "$ref": "#/components/examples/actions-fork-pr-contributor-approval" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set fork PR contributor approval permissions for an organization description: |- Sets the fork PR contributor approval policy for an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-fork-pr-contributor-approval-permissions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: summary: Set approval policy to first time contributors value: approval_policy: first_time_contributors x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": get: summary: Get private repo fork PR workflow settings for an organization description: Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. operationId: actions/get-private-repo-fork-pr-workflows-settings-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" examples: default: "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set private repo fork PR workflow settings for an organization description: Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. operationId: actions/set-private-repo-fork-pr-workflows-settings-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" examples: default: "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" responses: '204': description: Empty response for successful settings update '403': description: Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner content: application/json: schema: "$ref": "#/components/schemas/basic-error" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization description: |- Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/list-selected-repositories-enabled-github-actions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: number repositories: type: array items: "$ref": "#/components/schemas/repository" examples: default: "$ref": "#/components/examples/repository-paginated" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions put: summary: Set selected repositories enabled for GitHub Actions in an organization description: |- Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-selected-repositories-enabled-github-actions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: description: List of repository IDs to enable for GitHub Actions. type: array items: type: integer description: Unique identifier of the repository. required: - selected_repository_ids examples: default: value: selected_repository_ids: - 32 - 42 x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions "/orgs/{org}/actions/permissions/repositories/{repository_id}": put: summary: Enable a selected repository for GitHub Actions in an organization description: |- Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/enable-selected-repository-github-actions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions delete: summary: Disable a selected repository for GitHub Actions in an organization description: |- Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/disable-selected-repository-github-actions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions "/orgs/{org}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for an organization description: |- Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/get-allowed-actions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/selected-actions" examples: default: "$ref": "#/components/examples/selected-actions" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions put: summary: Set allowed actions for an organization description: |- Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-allowed-actions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Response requestBody: required: false content: application/json: schema: "$ref": "#/components/schemas/selected-actions" examples: selected_actions: "$ref": "#/components/examples/selected-actions" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions "/orgs/{org}/actions/permissions/self-hosted-runners": get: summary: Get self-hosted runners settings for an organization description: |- Gets the settings for self-hosted runners for an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/get-self-hosted-runners-permissions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/self-hosted-runners-settings" examples: response: summary: Example response value: enabled_repositories: selected selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set self-hosted runners settings for an organization description: |- Sets the settings for self-hosted runners for an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/set-self-hosted-runners-permissions-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object required: - enabled_repositories properties: enabled_repositories: type: string description: The policy that controls whether self-hosted runners can be used in the organization enum: - all - selected - none examples: application/json: value: enabled_repositories: all responses: '204': description: No content '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '422': "$ref": "#/components/responses/validation_failed" x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": get: summary: List repositories allowed to use self-hosted runners in an organization description: |- Lists repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/list-selected-repositories-self-hosted-runners-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/repository" examples: default: "$ref": "#/components/examples/repository-paginated" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set repositories allowed to use self-hosted runners in an organization description: |- Sets repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/set-selected-repositories-self-hosted-runners-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object required: - selected_repository_ids properties: selected_repository_ids: type: array items: type: integer description: IDs of repositories that can use repository-level self-hosted runners examples: application/json: value: selected_repository_ids: - 1 - 2 - 3 responses: '204': description: No content '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": put: summary: Add a repository to the list of repositories allowed to use self-hosted runners in an organization description: |- Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/enable-selected-repository-self-hosted-runners-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" responses: '204': description: No content '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '422': "$ref": "#/components/responses/validation_failed" x-github: enabledForGitHubApps: true category: actions subcategory: permissions delete: summary: Remove a repository from the list of repositories allowed to use self-hosted runners in an organization description: |- Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. operationId: actions/disable-selected-repository-self-hosted-runners-organization tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" responses: '204': description: No content '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '422': "$ref": "#/components/responses/validation_failed" x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/get-github-actions-default-workflow-permissions-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-get-default-workflow-permissions" examples: default: "$ref": "#/components/examples/actions-default-workflow-permissions" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set default workflow permissions for an organization description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/set-github-actions-default-workflow-permissions-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Success response '409': description: Conflict response when changing a setting is prevented by the owning enterprise requestBody: required: false content: application/json: schema: "$ref": "#/components/schemas/actions-set-default-workflow-permissions" examples: default: "$ref": "#/components/examples/actions-default-workflow-permissions" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions "/orgs/{org}/actions/runner-groups": get: summary: List self-hosted runner groups for an organization description: |- Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/list-self-hosted-runner-groups-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/visible-to-repository" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runner_groups properties: total_count: type: number runner_groups: type: array items: "$ref": "#/components/schemas/runner-groups-org" examples: default: "$ref": "#/components/examples/runner-groups-org" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups post: summary: Create a self-hosted runner group for an organization description: |- Creates a new self-hosted runner group for an organization. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/create-self-hosted-runner-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner group. type: string visibility: description: Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. type: string enum: - selected - all - private default: all selected_repository_ids: description: List of repository IDs that can access the runner group. type: array items: type: integer description: Unique identifier of the repository. runners: description: List of runner IDs to add to the runner group. type: array items: type: integer description: Unique identifier of the runner. allows_public_repositories: description: Whether the runner group can be used by `public` repositories. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main network_configuration_id: description: The identifier of a hosted compute network configuration. type: string required: - name examples: default: value: name: Expensive hardware runners visibility: selected selected_repository_ids: - 32 - 91 runners: - 9 - 2 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner-groups-org" examples: default: "$ref": "#/components/examples/runner-group" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}": get: summary: Get a self-hosted runner group for an organization description: |- Gets a specific self-hosted runner group for an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/get-self-hosted-runner-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner-groups-org" examples: default: "$ref": "#/components/examples/runner-group-item" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups patch: summary: Update a self-hosted runner group for an organization description: |- Updates the `name` and `visibility` of a self-hosted runner group in an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/update-self-hosted-runner-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the runner group. type: string visibility: description: Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. type: string enum: - selected - all - private allows_public_repositories: description: Whether the runner group can be used by `public` repositories. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main network_configuration_id: description: The identifier of a hosted compute network configuration. type: string nullable: true required: - name examples: default: value: name: Expensive hardware runners visibility: selected responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner-groups-org" examples: default: "$ref": "#/components/examples/runner-group" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups delete: summary: Delete a self-hosted runner group from an organization description: |- Deletes a self-hosted runner group for an organization. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/delete-self-hosted-runner-group-from-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": get: summary: List GitHub-hosted runners in a group for an organization description: |- Lists the GitHub-hosted runners in an organization group. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/list-github-hosted-runners-in-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runners properties: total_count: type: number runners: type: array items: "$ref": "#/components/schemas/actions-hosted-runner" examples: default: "$ref": "#/components/examples/actions-hosted-runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": get: summary: List repository access to a self-hosted runner group in an organization description: |- Lists the repositories with access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: number repositories: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-paginated" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups put: summary: Set repository access for a self-hosted runner group in an organization description: |- Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: description: List of repository IDs that can access the runner group. type: array items: type: integer description: Unique identifier of the repository. required: - selected_repository_ids examples: default: value: selected_repository_ids: - 32 - 91 responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": put: summary: Add repository access to a self-hosted runner group in an organization description: |- Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups delete: summary: Remove repository access to a self-hosted runner group in an organization description: |- Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": get: summary: List self-hosted runners in a group for an organization description: |- Lists self-hosted runners that are in a specific organization group. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/list-self-hosted-runners-in-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runners properties: total_count: type: number runners: type: array items: "$ref": "#/components/schemas/runner" examples: default: "$ref": "#/components/examples/runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups put: summary: Set self-hosted runners in a group for an organization description: |- Replaces the list of self-hosted runners that are part of an organization runner group. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-self-hosted-runners-in-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" requestBody: required: true content: application/json: schema: type: object properties: runners: description: List of runner IDs to add to the runner group. type: array items: type: integer description: Unique identifier of the runner. required: - runners examples: default: value: runners: - 9 - 2 responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": put: summary: Add a self-hosted runner to a group for an organization description: |- Adds a self-hosted runner to a runner group configured in an organization. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/add-self-hosted-runner-to-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/runner-id" responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups delete: summary: Remove a self-hosted runner from a group for an organization description: |- Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/remove-self-hosted-runner-from-group-for-org tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-group-id" - "$ref": "#/components/parameters/runner-id" responses: '204': description: Response x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runners": get: summary: List self-hosted runners for an organization description: |- Lists all self-hosted runners configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-self-hosted-runners-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization parameters: - name: name description: The name of a self-hosted runner. in: query schema: type: string - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runners properties: total_count: type: integer runners: type: array items: "$ref": "#/components/schemas/runner" examples: default: "$ref": "#/components/examples/runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/runners/downloads": get: summary: List runner applications for an organization description: |- Lists binaries for the runner application that you can download and run. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-runner-applications-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/runner-application" examples: default: "$ref": "#/components/examples/runner-application-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/runners/generate-jitconfig": post: summary: Create configuration for a just-in-time runner for an organization description: |- Generates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the organization. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/generate-runner-jitconfig-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object required: - name - runner_group_id - labels properties: name: type: string description: The name of the new runner. runner_group_id: type: integer description: The ID of the runner group to register the runner to. labels: type: array minItems: 1 maxItems: 100 items: type: string description: 'The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.' work_folder: type: string description: The working directory to be used for job execution, relative to the runner install directory. default: _work examples: default: value: name: New runner runner_group_id: 1 labels: - self-hosted - X64 - macOS - no-gpu work_folder: _work responses: '201': "$ref": "#/components/responses/actions_runner_jitconfig" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/runners/registration-token": post: summary: Create a registration token for an organization description: |- Returns a token that you can pass to the `config` script. The token expires after one hour. For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: ``` ./config.sh --url https://github.com/octo-org --token TOKEN ``` Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/create-registration-token-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/authentication-token" examples: default: "$ref": "#/components/examples/authentication-token" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/runners/remove-token": post: summary: Create a remove token for an organization description: |- 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 ``` Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/create-remove-token-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/authentication-token" examples: default: "$ref": "#/components/examples/authentication-token-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/runners/{runner_id}": get: summary: Get a self-hosted runner for an organization description: |- Gets a specific self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/get-self-hosted-runner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner" examples: default: "$ref": "#/components/examples/runner" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners delete: summary: Delete a self-hosted runner from an organization description: |- Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/delete-self-hosted-runner-from-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-id" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/runners/{runner_id}/labels": get: summary: List labels for a self-hosted runner for an organization description: |- Lists all labels for a self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-labels-for-self-hosted-runner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-id" responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners post: summary: Add custom labels to a self-hosted runner for an organization description: |- Adds custom labels to a self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/add-custom-labels-to-self-hosted-runner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-id" requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 1 maxItems: 100 description: The names of the custom labels to add to the runner. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners put: summary: Set custom labels for a self-hosted runner for an organization description: |- Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-custom-labels-for-self-hosted-runner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-id" requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 0 maxItems: 100 description: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners delete: summary: Remove all custom labels from a self-hosted runner for an organization description: |- Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-id" responses: '200': "$ref": "#/components/responses/actions_runner_labels_readonly" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": delete: summary: Remove a custom label from a self-hosted runner for an organization description: |- Remove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-custom-label-from-self-hosted-runner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner-id" - "$ref": "#/components/parameters/runner-label-name" responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/orgs/{org}/actions/secrets": get: summary: List organization secrets description: |- Lists all secrets available in an organization without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-org-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/organization-actions-secret" examples: default: "$ref": "#/components/examples/organization-actions-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/orgs/{org}/actions/secrets/public-key": get: summary: Get an organization public key description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. The authenticated user must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/get-org-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-public-key" examples: default: "$ref": "#/components/examples/actions-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/orgs/{org}/actions/secrets/{secret_name}": get: summary: Get an organization secret description: |- Gets a single organization secret without revealing its encrypted value. The authenticated user must have collaborator access to a repository to create, update, or read secrets OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/get-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-actions-secret" examples: default: "$ref": "#/components/examples/organization-actions-secret" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets put: summary: Create or update an organization secret description: |- Creates or updates an organization secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/create-or-update-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: ID of the key you used to encrypt the secret. visibility: type: string description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. enum: - all - private - selected selected_repository_ids: type: array description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer required: - encrypted_value - key_id - visibility examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' visibility: selected selected_repository_ids: - 1296269 - 1296280 responses: '201': description: Response when creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets delete: summary: Delete an organization secret description: |- Deletes a secret in an organization using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/delete-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/orgs/{org}/actions/secrets/{secret_name}/repositories": get: summary: List selected repositories for an organization secret description: |- Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/public-repository-paginated" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets put: summary: Set selected repositories for an organization secret description: |- Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: type: array description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer required: - selected_repository_ids examples: default: value: selected_repository_ids: - 64780797 responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret description: |- Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. For more information about setting the visibility, see [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `admin: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. tags: - actions operationId: actions/add-selected-repo-to-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: No Content when repository was added to the selected list '409': description: Conflict when visibility type is not set to selected x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets delete: summary: Remove selected repository from an organization secret description: |- Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-selected-repo-from-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: Response when repository was removed from the selected list '409': description: Conflict when visibility type not set to selected x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/orgs/{org}/actions/variables": get: summary: List organization variables description: |- Lists all organization variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-org-variables externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variables-per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - variables properties: total_count: type: integer variables: type: array items: "$ref": "#/components/schemas/organization-actions-variable" examples: default: "$ref": "#/components/examples/organization-actions-variables-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables post: summary: Create an organization variable description: |- Creates an organization variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/create-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. visibility: type: string description: The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. enum: - all - private - selected selected_repository_ids: type: array description: An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. items: type: integer required: - name - value - visibility examples: default: value: name: USERNAME value: octocat visibility: selected selected_repository_ids: - 1296269 - 1296280 responses: '201': description: Response when creating a variable content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/orgs/{org}/actions/variables/{name}": get: summary: Get an organization variable description: |- Gets a specific variable in an organization. The authenticated user must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/get-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variable-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-actions-variable" examples: default: "$ref": "#/components/examples/organization-actions-variable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables patch: summary: Update an organization variable description: |- Updates an organization variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/update-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variable-name" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. visibility: type: string description: The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. enum: - all - private - selected selected_repository_ids: type: array description: An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. items: type: integer examples: default: value: name: USERNAME value: octocat visibility: selected selected_repository_ids: - 1296269 - 1296280 responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables delete: summary: Delete an organization variable description: |- Deletes an organization variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the`admin: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. tags: - actions operationId: actions/delete-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variable-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/orgs/{org}/actions/variables/{name}/repositories": get: summary: List selected repositories for an organization variable description: |- Lists all repositories that can access an organization variable that is available to selected repositories. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-selected-repos-for-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variable-name" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/public-repository-paginated" '409': description: Response when the visibility of the variable is not set to `selected` x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables put: summary: Set selected repositories for an organization variable description: |- Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-selected-repos-for-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variable-name" requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: type: array description: The IDs of the repositories that can access the organization variable. items: type: integer required: - selected_repository_ids examples: default: value: selected_repository_ids: - 64780797 responses: '204': description: Response '409': description: Response when the visibility of the variable is not set to `selected` x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": put: summary: Add selected repository to an organization variable description: |- Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `admin: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. tags: - actions operationId: actions/add-selected-repo-to-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variable-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: Response '409': description: Response when the visibility of the variable is not set to `selected` x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables delete: summary: Remove selected repository from an organization variable description: |- Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-selected-repo-from-org-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/variable-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: Response '409': description: Response when the visibility of the variable is not set to `selected` x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/orgs/{org}/announcement": get: summary: Get announcement banner for organization description: |- Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint. tags: - orgs operationId: announcement-banners/get-announcement-banner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/announcement-banner" examples: default: "$ref": "#/components/examples/announcement" x-github: githubCloudOnly: true enabledForGitHubApps: true category: announcement-banners subcategory: organizations patch: summary: Set announcement banner for organization description: Sets the announcement banner to display for the organization. tags: - orgs operationId: announcement-banners/set-announcement-banner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/announcement" examples: default: "$ref": "#/components/examples/announcement" parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/announcement-banner" examples: default: "$ref": "#/components/examples/announcement" x-github: githubCloudOnly: true enabledForGitHubApps: true category: announcement-banners subcategory: organizations delete: summary: Remove announcement banner from organization description: Removes the announcement banner currently set for the organization. tags: - orgs operationId: announcement-banners/remove-announcement-banner-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: true category: announcement-banners subcategory: organizations "/orgs/{org}/artifacts/metadata/deployment-record": post: summary: Create an artifact deployment record description: |- Create or update deployment records for an artifact associated with an organization. This endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment. tags: - orgs operationId: orgs/create-artifact-deployment-record externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the artifact. minLength: 1 example: libfoo digest: type: string description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string description: The artifact version. minLength: 1 maxLength: 100 x-multi-segment: true example: 1.2.3 status: type: string description: The status of the artifact. Can be either deployed or decommissioned. enum: - deployed - decommissioned logical_environment: type: string description: The stage of the deployment. physical_environment: type: string description: The physical region of the deployment. cluster: type: string description: The deployment cluster. deployment_name: type: string description: The name of the deployment. tags: type: object description: The tags associated with the deployment. additionalProperties: type: string maxProperties: 5 runtime_risks: type: array description: A list of runtime risks associated with the deployment. maxItems: 4 uniqueItems: true items: type: string enum: - critical-resource - internet-exposed - lateral-movement - sensitive-data github_repository: type: string description: |- The name of the GitHub repository associated with the artifact. This should be used when there are no provenance attestations available for the artifact. The repository must belong to the organization specified in the path parameter. If a provenance attestation is available for the artifact, the API will use the repository information from the attestation instead of this parameter. minLength: 1 maxLength: 100 pattern: "^[A-Za-z0-9.\\-_]+$" example: my-github-repo required: - name - digest - status - logical_environment - deployment_name examples: default: value: name: awesome-image digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 status: deployed logical_environment: prod physical_environment: pacific-east cluster: moda-1 deployment_name: deployment-pod tags: data-access: sensitive responses: '200': description: Artifact deployment record stored successfully. content: application/json: schema: type: object properties: total_count: description: The number of deployment records created type: integer deployment_records: type: array items: "$ref": "#/components/schemas/artifact-deployment-record" examples: default: "$ref": "#/components/examples/artifact-deployment-record-list" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: artifact-metadata "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": post: summary: Set cluster deployment records description: Set deployment records for a given cluster. tags: - orgs operationId: orgs/set-cluster-deployment-records externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - "$ref": "#/components/parameters/org" - name: cluster in: path description: The cluster name. required: true schema: type: string minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9._-]+$" requestBody: required: true content: application/json: schema: type: object properties: logical_environment: type: string description: The stage of the deployment. physical_environment: type: string description: The physical region of the deployment. deployments: type: array description: The list of deployments to record. items: type: object maxLength: 100 properties: name: type: string description: The name of the artifact. minLength: 1 maxLength: 255 digest: type: string description: The hex encoded digest of the artifact. minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string description: The artifact version. minLength: 1 maxLength: 100 x-multi-segment: true example: 1.2.3 status: type: string description: The deployment status of the artifact. enum: - deployed - decommissioned deployment_name: type: string description: The name of the deployment. minLength: 1 maxLength: 128 github_repository: type: string description: |- The name of the GitHub repository associated with the artifact. This should be used when there are no provenance attestations available for the artifact. The repository must belong to the organization specified in the path parameter. If a provenance attestation is available for the artifact, the API will use the repository information from the attestation instead of this parameter. minLength: 1 maxLength: 100 pattern: "^[A-Za-z0-9.\\-_]+$" example: my-github-repo tags: type: object description: Key-value pairs to tag the deployment record. additionalProperties: type: string runtime_risks: type: array description: A list of runtime risks associated with the deployment. maxItems: 4 uniqueItems: true items: type: string enum: - critical-resource - internet-exposed - lateral-movement - sensitive-data examples: default: value: name: awesome-image digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 version: 2.1.0 status: deployed logical_environment: prod physical_environment: pacific-east cluster: moda-1 deployment_name: deployment-pod tags: runtime-risk: sensitive-data responses: '200': description: Artifact deployment record stored successfully. content: application/json: schema: type: object properties: total_count: description: The number of deployment records created type: integer deployment_records: type: array items: "$ref": "#/components/schemas/artifact-deployment-record" examples: default: "$ref": "#/components/examples/artifact-deployment-record-list" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: artifact-metadata "/orgs/{org}/artifacts/metadata/storage-record": post: summary: Create artifact metadata storage record description: |- Create metadata storage records for artifacts associated with an organization. This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and associated with a repository owned by the organization. tags: - orgs operationId: orgs/create-artifact-storage-record externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the artifact. example: libfoo minLength: 1 digest: type: string description: The digest of the artifact (algorithm:hex-encoded-digest). example: sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" version: type: string description: The artifact version. minLength: 1 maxLength: 100 x-multi-segment: true example: 1.2.3 artifact_url: type: string format: uri pattern: "^https://" description: The URL where the artifact is stored. example: https://reg.example.com/artifactory/bar/libfoo-1.2.3 path: type: string format: uri description: The path of the artifact. example: com/github/bar/libfoo-1.2.3 registry_url: type: string format: uri pattern: "^https://" description: The base URL of the artifact registry. example: https://reg.example.com/artifactory/ minLength: 1 repository: type: string description: The repository name within the registry. example: bar status: type: string description: The status of the artifact (e.g., active, inactive). example: active enum: - active - eol - deleted default: active github_repository: type: string description: |- The name of the GitHub repository associated with the artifact. This should be used when there are no provenance attestations available for the artifact. The repository must belong to the organization specified in the path parameter. If a provenance attestation is available for the artifact, the API will use the repository information from the attestation instead of this parameter. minLength: 1 maxLength: 100 pattern: "^[A-Za-z0-9.\\-_]+$" example: my-github-repo required: - name - digest - registry_url examples: default: value: name: libfoo version: 1.2.3 digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 registry_url: https://reg.example.com/artifactory/ repository: bar status: active responses: '200': description: Artifact metadata storage record stored successfully. content: application/json: schema: type: object properties: total_count: type: integer example: 1 storage_records: type: array items: type: object properties: id: type: integer name: type: string digest: type: string artifact_url: type: string nullable: true registry_url: type: string repository: type: string nullable: true status: type: string created_at: type: string updated_at: type: string examples: default: value: total_count: 1 storage_records: - name: libfoo digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 registry_url: https://reg.example.com/artifactory/ repository: bar status: active created_at: '2023-10-01T12:00:00Z' updated_at: '2023-10-01T12:00:00Z' x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: artifact-metadata "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": get: summary: List artifact deployment records description: List deployment records for an artifact metadata associated with an organization. tags: - orgs operationId: orgs/list-artifact-deployment-records externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/subject-digest" responses: '200': description: Successful response content: application/json: schema: type: object properties: total_count: description: The number of deployment records for this digest and organization example: 3 type: integer deployment_records: type: array items: "$ref": "#/components/schemas/artifact-deployment-record" examples: default: "$ref": "#/components/examples/artifact-deployment-record-list" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: artifact-metadata "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": get: summary: List artifact storage records description: |- List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. The collection of storage records 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 `content:read` permission is required. tags: - orgs operationId: orgs/list-artifact-storage-records externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - "$ref": "#/components/parameters/org" - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. in: path required: true example: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 schema: type: string minLength: 71 maxLength: 71 pattern: "^sha256:[a-f0-9]{64}$" x-multi-segment: true responses: '200': description: Response content: application/json: schema: type: object properties: total_count: description: The number of storage records for this digest and organization example: 3 type: integer storage_records: type: array items: type: object properties: id: type: integer name: type: string digest: type: string artifact_url: type: string registry_url: type: string repository: type: string status: type: string created_at: type: string updated_at: type: string examples: default: value: storage_records: - name: libfoo-1.2.3 digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 registry_url: https://reg.example.com/artifactory/ repository: bar status: active created_at: '2023-10-01T12:00:00Z' updated_at: '2023-10-01T12:00:00Z' x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: artifact-metadata "/orgs/{org}/attestations/bulk-list": post: summary: List attestations by bulk subject digests description: |- List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. 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 `attestations:read` permission is required. **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - orgs operationId: orgs/list-attestations-bulk externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: subject_digests: type: array items: type: string description: List of subject digests to fetch attestations for. minItems: 1 maxItems: 1024 predicate_type: type: string description: |- Optional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types. required: - subject_digests examples: default: "$ref": "#/components/examples/bulk-subject-digest-body" withPredicateType: "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" responses: '200': description: Response content: application/json: schema: type: object properties: attestations_subject_digests: type: object additionalProperties: nullable: true type: array items: type: object properties: bundle: type: object properties: mediaType: type: string verificationMaterial: type: object properties: {} additionalProperties: true dsseEnvelope: type: object properties: {} additionalProperties: true description: The bundle of the attestation. repository_id: type: integer bundle_url: type: string description: Mapping of subject digest to bundles. page_info: type: object properties: has_next: type: boolean description: Indicates whether there is a next page. has_previous: type: boolean description: Indicates whether there is a previous page. next: type: string description: The cursor to the next page. previous: type: string description: The cursor to the previous page. description: Information about the current page. examples: default: "$ref": "#/components/examples/list-attestations-bulk" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: attestations "/orgs/{org}/attestations/delete-request": post: summary: Delete attestations in bulk description: Delete artifact attestations in bulk by either subject digests or unique ID. tags: - orgs operationId: orgs/delete-attestations-bulk externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object oneOf: - properties: subject_digests: type: array items: type: string description: List of subject digests associated with the artifact attestations to delete. minItems: 1 maxItems: 1024 required: - subject_digests - properties: attestation_ids: type: array items: type: integer description: List of unique IDs associated with the artifact attestations to delete. minItems: 1 maxItems: 1024 required: - attestation_ids description: The request body must include either `subject_digests` or `attestation_ids`, but not both. examples: by-subject-digests: summary: Delete by subject digests value: subject_digests: - sha256:abc123 - sha512:def456 by-attestation-ids: summary: Delete by attestation IDs value: attestation_ids: - 111 - 222 responses: '200': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: attestations "/orgs/{org}/attestations/digest/{subject_digest}": delete: summary: Delete attestations by subject digest description: Delete an artifact attestation by subject digest. tags: - orgs operationId: orgs/delete-attestations-by-subject-digest externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - "$ref": "#/components/parameters/org" - name: subject_digest description: Subject Digest in: path required: true schema: type: string x-multi-segment: true responses: '200': description: Response '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: attestations "/orgs/{org}/attestations/repositories": get: summary: List attestation repositories description: |- List repositories owned by the provided organization that have created at least one attested artifact Results will be sorted in ascending order by repository ID tags: - orgs operationId: orgs/list-attestation-repositories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/org" - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: type: array items: type: object properties: id: type: integer name: type: string examples: default: "$ref": "#/components/examples/list-attestation-repositories" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: attestations "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID description: Delete an artifact attestation by unique ID that is associated with a repository owned by an org. tags: - orgs operationId: orgs/delete-attestations-by-id externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - "$ref": "#/components/parameters/org" - name: attestation_id description: Attestation ID in: path required: true schema: type: integer responses: '200': description: Response '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: attestations "/orgs/{org}/attestations/{subject_digest}": get: summary: List attestations description: |- List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. 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 `attestations:read` permission is required. **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - orgs operationId: orgs/list-attestations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/org" - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. in: path required: true schema: type: string x-multi-segment: true - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: type: object properties: attestations: type: array items: type: object properties: bundle: type: object properties: mediaType: type: string verificationMaterial: type: object properties: {} additionalProperties: true dsseEnvelope: type: object properties: {} additionalProperties: true description: |- The attestation's Sigstore Bundle. Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer bundle_url: type: string initiator: type: string examples: default: "$ref": "#/components/examples/list-attestations" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: attestations "/orgs/{org}/audit-log": get: summary: Get the audit log for an organization description: |- Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](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)." Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." 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 "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. operationId: orgs/get-audit-log tags: - orgs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/audit-log-phrase" - "$ref": "#/components/parameters/audit-log-include" - "$ref": "#/components/parameters/audit-log-after" - "$ref": "#/components/parameters/audit-log-before" - "$ref": "#/components/parameters/audit-log-order" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/audit-log-event" examples: default: "$ref": "#/components/examples/audit-log" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/blocks": get: summary: List users blocked by an organization description: List the users blocked by an organization. tags: - orgs operationId: orgs/list-blocked-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: blocking "/orgs/{org}/blocks/{username}": get: summary: Check if a user is blocked by an organization description: Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. tags: - orgs operationId: orgs/check-blocked-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: If the user is blocked '404': description: If the user is not blocked content: application/json: schema: "$ref": "#/components/schemas/basic-error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: blocking put: summary: Block a user from an organization description: 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. tags: - orgs operationId: orgs/block-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: blocking delete: summary: Unblock a user from an organization description: Unblocks the given user on behalf of the specified organization. tags: - orgs operationId: orgs/unblock-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: blocking "/orgs/{org}/bypass-requests/push-rules": get: summary: List push rule bypass requests within an organization description: Lists the requests made by users of a repository to bypass push protection rules within an organization. tags: - orgs operationId: orgs/list-push-bypass-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: bypass-requests parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-name-in-query" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/bypass-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/push-rule-bypass-request" examples: default: "$ref": "#/components/examples/push-rule-bypass-request-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/bypass-requests/secret-scanning": get: summary: List bypass requests for secret scanning for an org description: |- List requests to bypass secret scanning push protection in an org. Delegated bypass must be enabled on repositories in the org and the user must be a bypass reviewer to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/list-org-bypass-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-name-in-query" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/bypass-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/secret-scanning-bypass-request" examples: default: "$ref": "#/components/examples/secret-scanning-bypass-request-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/campaigns": get: summary: List campaigns for an organization description: |- Lists campaigns in an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - campaigns operationId: campaigns/list-org-campaigns externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - name: state description: If specified, only campaigns with this state will be returned. in: query required: false schema: "$ref": "#/components/schemas/campaign-state" - name: sort description: The property by which to sort the results. in: query required: false schema: type: string enum: - created - updated - ends_at - published default: created responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/campaign-summary" examples: default: "$ref": "#/components/examples/campaign-org-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: campaigns subcategory: campaigns post: summary: Create a campaign for an organization description: |- Create a campaign for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included in the campaign. tags: - campaigns operationId: campaigns/create-campaign externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: name: description: The name of the campaign type: string minLength: 1 maxLength: 50 description: description: A description for the campaign type: string minLength: 1 maxLength: 255 managers: description: The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. type: array maxItems: 10 items: description: The login of each manager type: string team_managers: description: The slugs of the teams to set as the campaign managers. type: array maxItems: 10 items: description: The slug of each team type: string ends_at: description: The end date and time of the campaign. The date must be in the future. type: string format: date-time contact_link: description: The contact link of the campaign. Must be a URI. type: string format: uri nullable: true code_scanning_alerts: description: The code scanning alerts to include in this campaign type: array minItems: 1 items: type: object additionalProperties: false properties: repository_id: type: integer description: The repository id alert_numbers: type: array description: The alert numbers minItems: 1 items: type: integer required: - repository_id - alert_numbers nullable: true generate_issues: description: If true, will automatically generate issues for the campaign. The default is false. type: boolean default: false required: - name - description - ends_at oneOf: - required: - code_scanning_alerts - required: - secret_scanning_alerts examples: default: value: name: Critical CodeQL alerts description: Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage. managers: - octocat ends_at: '2024-03-14T00:00:00Z' code_scanning_alerts: - repository_id: 1296269 alert_numbers: - 1 - 2 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/campaign-summary" examples: default: "$ref": "#/components/examples/campaign-summary" '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/basic-error" '404': "$ref": "#/components/responses/not_found" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/basic-error" '429': description: Too Many Requests '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: campaigns subcategory: campaigns "/orgs/{org}/campaigns/{campaign_number}": get: summary: Get a campaign for an organization description: |- Gets a campaign for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - campaigns operationId: campaigns/get-campaign-summary externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - "$ref": "#/components/parameters/org" - name: campaign_number description: The campaign number. in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/campaign-summary" examples: default: "$ref": "#/components/examples/campaign-summary" '404': "$ref": "#/components/responses/not_found" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/basic-error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: campaigns subcategory: campaigns patch: summary: Update a campaign description: |- Updates a campaign in an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - campaigns operationId: campaigns/update-campaign externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - "$ref": "#/components/parameters/org" - name: campaign_number description: The campaign number. in: path required: true schema: type: integer requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: name: description: The name of the campaign type: string minLength: 1 maxLength: 50 description: description: A description for the campaign type: string minLength: 1 maxLength: 255 managers: description: The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. type: array maxItems: 10 items: type: string team_managers: description: The slugs of the teams to set as the campaign managers. type: array maxItems: 10 items: description: The slug of each team type: string ends_at: description: The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time contact_link: description: The contact link of the campaign. Must be a URI. type: string format: uri nullable: true state: "$ref": "#/components/schemas/campaign-state" examples: default: value: name: Critical CodeQL alerts responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/campaign-summary" examples: default: "$ref": "#/components/examples/campaign-summary" '400': description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/basic-error" '404': "$ref": "#/components/responses/not_found" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/basic-error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: campaigns subcategory: campaigns delete: summary: Delete a campaign for an organization description: |- Deletes a campaign in an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - campaigns operationId: campaigns/delete-campaign externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - "$ref": "#/components/parameters/org" - name: campaign_number description: The campaign number. in: path required: true schema: type: integer responses: '204': description: Deletion successful '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: campaigns subcategory: campaigns "/orgs/{org}/code-scanning/alerts": get: summary: List code scanning alerts for an organization description: |- Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/list-alerts-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/tool-name" - "$ref": "#/components/parameters/tool-guid" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false schema: "$ref": "#/components/schemas/code-scanning-alert-state-query" - name: sort description: The property by which to sort the results. in: query required: false schema: type: string enum: - created - updated default: created - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false schema: "$ref": "#/components/schemas/code-scanning-alert-severity" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-organization-alert-items" examples: default: "$ref": "#/components/examples/code-scanning-organization-alert-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning "/orgs/{org}/code-security/configurations": get: summary: Get code security configurations for an organization description: |- Lists all code security configurations available in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-configurations-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - "$ref": "#/components/parameters/org" - name: target_type in: query description: The target type of the code security configuration required: false schema: type: string enum: - global - all default: all - name: per_page in: query description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." required: false schema: type: integer default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/code-security-configuration-list" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations post: summary: Create a code security configuration description: |- Creates a code security configuration in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - code-security operationId: code-security/create-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: name: type: string description: The name of the code security configuration. Must be unique within the organization. description: type: string description: A description of the code security configuration maxLength: 255 advanced_security: type: string description: | The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. > [!WARNING] > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled - code_security - secret_protection default: disabled code_security: type: string description: The enablement status of GitHub Code Security features. enum: - enabled - disabled - not_set dependency_graph: type: string description: The enablement status of Dependency Graph enum: - enabled - disabled - not_set default: enabled dependency_graph_autosubmit_action: type: string description: The enablement status of Automatic dependency submission enum: - enabled - disabled - not_set default: disabled dependency_graph_autosubmit_action_options: type: object description: Feature options for Automatic dependency submission properties: labeled_runners: type: boolean description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. default: false dependabot_alerts: type: string description: The enablement status of Dependabot alerts enum: - enabled - disabled - not_set default: disabled dependabot_security_updates: type: string description: The enablement status of Dependabot security updates enum: - enabled - disabled - not_set default: disabled code_scanning_options: "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: type: string description: The enablement status of code scanning default setup enum: - enabled - disabled - not_set default: disabled code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert dismissal enum: - enabled - disabled - not_set default: not_set secret_protection: type: string description: The enablement status of GitHub Secret Protection features. enum: - enabled - disabled - not_set secret_scanning: type: string description: The enablement status of secret scanning enum: - enabled - disabled - not_set default: disabled secret_scanning_push_protection: type: string description: The enablement status of secret scanning push protection enum: - enabled - disabled - not_set default: disabled secret_scanning_delegated_bypass: type: string description: The enablement status of secret scanning delegated bypass enum: - enabled - disabled - not_set default: disabled secret_scanning_delegated_bypass_options: type: object description: Feature options for secret scanning delegated bypass properties: reviewers: type: array description: The bypass reviewers for secret scanning delegated bypass items: type: object required: - reviewer_id - reviewer_type properties: reviewer_id: type: integer description: The ID of the team or role selected as a bypass reviewer reviewer_type: type: string description: The type of the bypass reviewer enum: - TEAM - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks enum: - enabled - disabled - not_set default: disabled secret_scanning_non_provider_patterns: type: string description: The enablement status of secret scanning non provider patterns enum: - enabled - disabled - not_set default: disabled secret_scanning_generic_secrets: type: string description: The enablement status of Copilot secret scanning enum: - enabled - disabled - not_set default: disabled secret_scanning_delegated_alert_dismissal: type: string description: The enablement status of secret scanning delegated alert dismissal enum: - enabled - disabled - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting enum: - enabled - disabled - not_set default: disabled enforcement: type: string description: The enforcement status for a security configuration enum: - enforced - unenforced default: enforced required: - name - description examples: default: summary: Example for a code security configuration value: name: octo-org recommended settings description: This is a code security configuration for octo-org advanced_security: enabled dependabot_alerts: enabled dependabot_security_updates: not_set secret_scanning: enabled responses: '201': description: Successfully created code security configuration content: application/json: schema: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/code-security-configuration" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/orgs/{org}/code-security/configurations/defaults": get: summary: Get default code security configurations description: |- Lists the default code security configurations for an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-default-configurations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-security-default-configurations" examples: default: "$ref": "#/components/examples/code-security-default-configurations" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/orgs/{org}/code-security/configurations/detach": delete: summary: Detach configurations from repositories description: |- Detach code security configuration(s) from a set of repositories. Repositories will retain their settings but will no longer be associated with the configuration. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - code-security operationId: code-security/detach-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. minItems: 1 maxItems: 250 items: type: integer description: Unique identifier of the repository. examples: default: summary: Example for detaching repositories from configurations. value: selected_repository_ids: - 32 - 91 responses: '204': "$ref": "#/components/responses/no_content" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/orgs/{org}/code-security/configurations/{configuration_id}": get: summary: Get a code security configuration description: |- Gets a code security configuration available in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/configuration-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/code-security-configuration" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations patch: summary: Update a code security configuration description: |- Updates a code security configuration in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - code-security operationId: code-security/update-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/configuration-id" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: name: type: string description: The name of the code security configuration. Must be unique within the organization. description: type: string description: A description of the code security configuration maxLength: 255 advanced_security: type: string description: | The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. > [!WARNING] > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled - code_security - secret_protection code_security: type: string description: The enablement status of GitHub Code Security features. enum: - enabled - disabled - not_set dependency_graph: type: string description: The enablement status of Dependency Graph enum: - enabled - disabled - not_set dependency_graph_autosubmit_action: type: string description: The enablement status of Automatic dependency submission enum: - enabled - disabled - not_set dependency_graph_autosubmit_action_options: type: object description: Feature options for Automatic dependency submission properties: labeled_runners: type: boolean description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. dependabot_alerts: type: string description: The enablement status of Dependabot alerts enum: - enabled - disabled - not_set dependabot_security_updates: type: string description: The enablement status of Dependabot security updates enum: - enabled - disabled - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup enum: - enabled - disabled - not_set code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert dismissal enum: - enabled - disabled - not_set default: disabled secret_protection: type: string description: The enablement status of GitHub Secret Protection features. enum: - enabled - disabled - not_set secret_scanning: type: string description: The enablement status of secret scanning enum: - enabled - disabled - not_set secret_scanning_push_protection: type: string description: The enablement status of secret scanning push protection enum: - enabled - disabled - not_set secret_scanning_delegated_bypass: type: string description: The enablement status of secret scanning delegated bypass enum: - enabled - disabled - not_set secret_scanning_delegated_bypass_options: type: object description: Feature options for secret scanning delegated bypass properties: reviewers: type: array description: The bypass reviewers for secret scanning delegated bypass items: type: object required: - reviewer_id - reviewer_type properties: reviewer_id: type: integer description: The ID of the team or role selected as a bypass reviewer reviewer_type: type: string description: The type of the bypass reviewer enum: - TEAM - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks enum: - enabled - disabled - not_set secret_scanning_non_provider_patterns: type: string description: The enablement status of secret scanning non-provider patterns enum: - enabled - disabled - not_set secret_scanning_generic_secrets: type: string description: The enablement status of Copilot secret scanning enum: - enabled - disabled - not_set secret_scanning_delegated_alert_dismissal: type: string description: The enablement status of secret scanning delegated alert dismissal enum: - enabled - disabled - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting enum: - enabled - disabled - not_set enforcement: type: string description: The enforcement status for a security configuration enum: - enforced - unenforced examples: default: summary: Example for updating a code security configuration value: name: octo-org recommended settings v2 secret_scanning: disabled code_scanning_default_setup: enabled responses: '200': description: Response when a configuration is updated content: application/json: schema: "$ref": "#/components/schemas/code-security-configuration" examples: default: "$ref": "#/components/examples/code-security-configuration-updated" '204': description: Response when no new updates are made x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations delete: summary: Delete a code security configuration description: |- Deletes the desired code security configuration from an organization. Repositories attached to the configuration will retain their settings but will no longer be associated with the configuration. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - code-security operationId: code-security/delete-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/configuration-id" responses: '204': "$ref": "#/components/responses/no_content" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/orgs/{org}/code-security/configurations/{configuration_id}/attach": post: summary: Attach a configuration to repositories description: |- Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - code-security operationId: code-security/attach-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/configuration-id" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: scope: type: string description: The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` enum: - all - all_without_configurations - public - private_or_internal - selected selected_repository_ids: type: array description: An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. items: type: integer description: Unique identifier of the repository. required: - scope examples: default: summary: Example for attaching a configuration to some repositories value: scope: selected selected_repository_ids: - 32 - 91 responses: '202': "$ref": "#/components/responses/accepted" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": put: summary: Set a code security configuration as a default for an organization description: |- Sets a code security configuration as a default to be applied to new repositories in your organization. This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - code-security operationId: code-security/set-configuration-as-default externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/configuration-id" requestBody: required: true content: application/json: schema: type: object properties: default_for_new_repos: type: string description: Specify which types of repository this security configuration should be applied to by default. enum: - all - none - private_and_internal - public examples: default: summary: Set this configuration to be enabled by default on all new repositories. value: default_for_new_repos: all responses: '200': description: Default successfully changed. content: application/json: schema: type: object properties: default_for_new_repos: type: string description: Specifies which types of repository this security configuration is applied to by default. enum: - all - none - private_and_internal - public configuration: "$ref": "#/components/schemas/code-security-configuration" examples: default: value: default_for_new_repos: all configuration: "$ref": "#/components/examples/code-security-configuration" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": get: summary: Get repositories associated with a code security configuration description: |- Lists the repositories associated with a code security configuration in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-repositories-for-configuration externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/configuration-id" - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: integer default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` in: query required: false schema: type: string default: all responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-security-configuration-repositories" examples: default: summary: Example of code security configuration repositories value: - status: attached repository: "$ref": "#/components/examples/simple-repository" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/orgs/{org}/codespaces": get: summary: List codespaces for the organization description: |- Lists the codespaces associated to a specified organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-in-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - codespaces properties: total_count: type: integer codespaces: type: array items: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespaces-list" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organizations "/orgs/{org}/codespaces/access": put: summary: Manage access control for organization codespaces description: |- Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - "$ref": "#/components/parameters/org" deprecated: true requestBody: required: true content: application/json: schema: type: object properties: visibility: type: string description: Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. enum: - disabled - selected_members - all_members - all_members_and_outside_collaborators selected_usernames: type: array description: The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. items: type: string maxItems: 100 required: - visibility examples: default: value: visibility: selected_members selected_usernames: - johnDoe - atomIO responses: '204': description: Response when successfully modifying permissions. '304': "$ref": "#/components/responses/not_modified" '400': description: Users are neither members nor collaborators of this organization. '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organizations "/orgs/{org}/codespaces/access/selected_users": post: summary: Add users to Codespaces access for an organization description: |- Codespaces for the specified users will be billed to the organization. To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - "$ref": "#/components/parameters/org" deprecated: true requestBody: required: true content: application/json: schema: type: object properties: selected_usernames: type: array description: The usernames of the organization members whose codespaces be billed to the organization. items: type: string maxItems: 100 required: - selected_usernames examples: default: value: selected_usernames: - johnDoe - atomIO responses: '204': description: Response when successfully modifying permissions. '304': "$ref": "#/components/responses/not_modified" '400': description: Users are neither members nor collaborators of this organization. '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organizations delete: summary: Remove users from Codespaces access for an organization description: |- Codespaces for the specified users will no longer be billed to the organization. To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-codespaces-access-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: selected_usernames: type: array description: The usernames of the organization members whose codespaces should not be billed to the organization. items: type: string maxItems: 100 required: - selected_usernames examples: default: value: selected_usernames: - johnDoe - atomIO responses: '204': description: Response when successfully modifying permissions. '304': "$ref": "#/components/responses/not_modified" '400': description: Users are neither members nor collaborators of this organization. '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organizations "/orgs/{org}/codespaces/secrets": get: summary: List organization secrets description: |- Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-org-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/codespaces-org-secret" examples: default: "$ref": "#/components/examples/repo-codespaces-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets "/orgs/{org}/codespaces/secrets/public-key": get: summary: Get an organization public key description: |- Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-org-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespaces-public-key" examples: default: "$ref": "#/components/examples/codespaces-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets "/orgs/{org}/codespaces/secrets/{secret_name}": get: summary: Get an organization secret description: |- Gets an organization development environment secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespaces-org-secret" examples: default: "$ref": "#/components/examples/repo-codespaces-secret" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets put: summary: Create or update an organization secret description: |- Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: The ID of the key you used to encrypt the secret. visibility: type: string description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. enum: - all - private - selected selected_repository_ids: type: array description: An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer required: - visibility examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' visibility: selected selected_repository_ids: - 1296269 - 1296280 responses: '201': description: Response when creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response when updating a secret '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets delete: summary: Delete an organization secret description: |- Deletes an organization development environment secret using the secret name. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": get: summary: List selected repositories for an organization secret description: |- Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/public-repository-paginated" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets put: summary: Set selected repositories for an organization secret description: |- Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: type: array description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer required: - selected_repository_ids examples: default: value: selected_repository_ids: - 64780797 responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '409': description: Conflict when visibility type not set to selected x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret description: |- Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-selected-repo-to-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: No Content when repository was added to the selected list '404': "$ref": "#/components/responses/not_found" '409': description: Conflict when visibility type is not set to selected '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets delete: summary: Remove selected repository from an organization secret description: |- Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/remove-selected-repo-from-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: Response when repository was removed from the selected list '404': "$ref": "#/components/responses/not_found" '409': description: Conflict when visibility type not set to selected '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organization-secrets "/orgs/{org}/copilot/billing": get: summary: Get Copilot seat information and settings for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets information about an organization's Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/copilot-organization-details" examples: default: "$ref": "#/components/examples/copilot-organization-details" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: There is a problem with your account's associated payment method. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-user-management "/orgs/{org}/copilot/billing/seats": get: summary: List all Copilot seat assignments for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 50 responses: '200': description: Response content: application/json: schema: type: object properties: total_seats: type: integer description: Total number of Copilot seats for the organization currently being billed. seats: type: array items: "$ref": "#/components/schemas/copilot-seat-details" examples: default: "$ref": "#/components/examples/copilot-seats-list" headers: Link: "$ref": "#/components/headers/link" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-user-management "/orgs/{org}/copilot/billing/selected_teams": post: summary: Add teams to the Copilot subscription for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: content: application/json: schema: type: object properties: selected_teams: type: array description: List of team names within the organization to which to grant access to GitHub Copilot. items: type: string minItems: 1 required: - selected_teams examples: default: value: selected_teams: - engteam1 - engteam2 - engteam3 required: true responses: '201': description: OK content: application/json: schema: type: object description: The total number of seats created for members of the specified team(s). properties: seats_created: type: integer required: - seats_created examples: default: value: seats_created: 5 '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-user-management delete: summary: Remove teams from the Copilot subscription for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: content: application/json: schema: type: object properties: selected_teams: type: array description: The names of teams from which to revoke access to GitHub Copilot. items: type: string minItems: 1 required: - selected_teams examples: default: value: selected_teams: - engteam1 - engteam2 - engteam3 required: true responses: '200': description: OK content: application/json: schema: type: object description: The total number of seats set to "pending cancellation" for members of the specified team(s). properties: seats_cancelled: type: integer required: - seats_cancelled examples: default: value: seats_cancelled: 5 '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-user-management "/orgs/{org}/copilot/billing/selected_users": post: summary: Add users to the Copilot subscription for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/add-copilot-seats-for-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: content: application/json: schema: type: object properties: selected_usernames: type: array description: The usernames of the organization members to be granted access to GitHub Copilot. items: type: string minItems: 1 required: - selected_usernames examples: default: value: selected_usernames: - cooluser1 - hacker2 - octocat required: true responses: '201': description: OK content: application/json: schema: type: object description: The total number of seats created for the specified user(s). properties: seats_created: type: integer required: - seats_created examples: default: value: seats_created: 5 '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-user-management delete: summary: Remove users from the Copilot subscription for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: content: application/json: schema: type: object properties: selected_usernames: type: array description: The usernames of the organization members for which to revoke access to GitHub Copilot. items: type: string minItems: 1 required: - selected_usernames examples: default: value: selected_usernames: - cooluser1 - hacker2 - octocat required: true responses: '200': description: OK content: application/json: schema: type: object description: The total number of seats set to "pending cancellation" for the specified users. properties: seats_cancelled: type: integer required: - seats_cancelled examples: default: value: seats_cancelled: 5 '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-user-management "/orgs/{org}/copilot/metrics": get: summary: Get Copilot metrics for an organization description: |- Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. > [!NOTE] > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-metrics-for-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - "$ref": "#/components/parameters/org" - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. in: query required: false schema: type: string - name: until description: Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. in: query required: false schema: type: string - "$ref": "#/components/parameters/page" - name: per_page description: The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 100 responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/copilot-usage-metrics-day" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-for-day" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-metrics "/orgs/{org}/credential-authorizations": get: summary: List SAML SSO authorizations for an organization description: |- Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on). The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-saml-sso-authorizations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - name: page description: Page token in: query schema: type: integer - name: login description: Limits the list of credentials authorizations for an organization to a specific login in: query schema: type: string responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/credential-authorization" examples: default: "$ref": "#/components/examples/credential-authorization-items" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization description: |- Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/remove-saml-sso-authorization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - "$ref": "#/components/parameters/org" - name: credential_id in: path required: true schema: type: integer responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization description: |- List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/list-custom-repo-roles externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response - list of custom role names content: application/json: schema: type: object properties: total_count: description: The number of custom roles in this organization example: 3 type: integer custom_roles: type: array items: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-list-example" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: custom-roles post: summary: Create a custom repository role description: |- Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/create-custom-repo-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role-create-schema" examples: default: value: name: Labeler description: A role for issue and pull request labelers base_role: read permissions: - add_label responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-example" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: custom-roles "/orgs/{org}/custom-repository-roles/{role_id}": get: summary: Get a custom repository role description: |- Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/get-custom-repo-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-example" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: custom-roles patch: summary: Update a custom repository role description: |- Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/update-custom-repo-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role-update-schema" examples: default: value: name: Labeler description: A role for issue and PR labelers base_role: read permissions: - add_label - remove_label responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-example" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: custom-roles delete: summary: Delete a custom repository role description: |- Deletes a custom role from an organization. Once the custom role has been deleted, any user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/delete-custom-repo-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: custom-roles "/orgs/{org}/custom_roles": post: summary: Closing down - Create a custom role description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/create-custom-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role-create-schema" examples: default: value: name: Labeler description: A role for issue and pull request labelers base_role: read permissions: - add_label responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-example" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true removalDate: '2023-09-06' deprecationDate: '2023-03-06' category: orgs subcategory: custom-roles deprecated: true "/orgs/{org}/custom_roles/{role_id}": get: summary: Closing down - Get a custom role description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/get-custom-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-example" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true removalDate: '2022-09-06' deprecationDate: '2023-03-06' category: orgs subcategory: custom-roles deprecated: true patch: summary: Closing down - Update a custom role description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/update-custom-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role-update-schema" examples: default: value: name: Labeler description: A role for issue and PR labelers base_role: read permissions: - add_label - remove_label responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-custom-repository-role" examples: default: "$ref": "#/components/examples/organization-custom-repository-role-example" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true removalDate: '2022-09-06' deprecationDate: '2023-03-06' category: orgs subcategory: custom-roles deprecated: true delete: summary: Closing down - Delete a custom role description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. Deletes a custom role from an organization. Once the custom role has been deleted, any user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/delete-custom-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: true removalDate: '2022-09-06' deprecationDate: '2023-03-06' category: orgs subcategory: custom-roles deprecated: true "/orgs/{org}/dependabot/alerts": get: summary: List Dependabot alerts for an organization description: |- Lists Dependabot alerts for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - dependabot operationId: dependabot/list-alerts-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-states" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry" - "$ref": "#/components/parameters/dependabot-alert-org-scope-comma-separated-has" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-runtime-risk" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/dependabot-alert-with-repository" examples: default: "$ref": "#/components/examples/dependabot-alerts-for-organization" '304': "$ref": "#/components/responses/not_modified" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: alerts "/orgs/{org}/dependabot/secrets": get: summary: List organization secrets description: |- Lists all secrets available in an organization without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-org-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/organization-dependabot-secret" examples: default: "$ref": "#/components/examples/organization-dependabot-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/orgs/{org}/dependabot/secrets/public-key": get: summary: Get an organization public key description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-org-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependabot-public-key" examples: default: "$ref": "#/components/examples/dependabot-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/orgs/{org}/dependabot/secrets/{secret_name}": get: summary: Get an organization secret description: |- Gets a single organization secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-dependabot-secret" examples: default: "$ref": "#/components/examples/organization-dependabot-secret" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets put: summary: Create or update an organization secret description: |- Creates or updates an organization secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/create-or-update-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: ID of the key you used to encrypt the secret. visibility: type: string description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. enum: - all - private - selected selected_repository_ids: type: array description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. Use integers when possible, as strings are supported only to maintain backwards compatibility and may be removed in the future. items: anyOf: - type: integer - type: string required: - visibility examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' visibility: selected selected_repository_ids: - 1296269 - 1296280 responses: '201': description: Response when creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets delete: summary: Delete an organization secret description: |- Deletes a secret in an organization using the secret name. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/delete-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": get: summary: List selected repositories for an organization secret description: |- Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/public-repository-paginated" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets put: summary: Set selected repositories for an organization secret description: |- Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/set-selected-repos-for-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: type: array description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: type: integer required: - selected_repository_ids examples: default: value: selected_repository_ids: - 64780797 responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret description: |- Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/add-selected-repo-to-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: No Content when repository was added to the selected list '409': description: Conflict when visibility type is not set to selected x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets delete: summary: Remove selected repository from an organization secret description: |- Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/remove-selected-repo-from-org-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: Response when repository was removed from the selected list '409': description: Conflict when visibility type not set to selected x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/orgs/{org}/dismissal-requests/code-scanning": get: summary: List dismissal requests for code scanning alerts for an organization description: |- Lists dismissal requests for code scanning alerts for all repositories in an organization. The user must be authorized to review dismissal requests for the organization. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - code-scanning operationId: code-scanning/list-org-dismissal-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-an-organization x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/alert-dismissal-reviewer-name" - "$ref": "#/components/parameters/alert-dismissal-requester-name" - "$ref": "#/components/parameters/alert-dismissal-time-period" - "$ref": "#/components/parameters/alert-dismissal-request-status" - "$ref": "#/components/parameters/repository-name-in-query" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of alert dismissal requests. content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-alert-dismissal-request" examples: default: "$ref": "#/components/examples/code-scanning-alert-dismissal-request-items" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/dismissal-requests/secret-scanning": get: summary: List alert dismissal requests for secret scanning for an org description: |- Lists requests to dismiss secret scanning alerts in an org. Delegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager, or have the "Review and manage secret scanning alert dismissal requests" permission to access this endpoint. tags: - secret-scanning operationId: secret-scanning/list-org-dismissal-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-an-org x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-name-in-query" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/dismissal-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of the alert dismissal requests. content: application/json: schema: type: array items: "$ref": "#/components/schemas/secret-scanning-dismissal-request" examples: default: "$ref": "#/components/examples/secret-scanning-dismissal-request-items" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for organization description: |- Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/packages-for-org" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/orgs/{org}/events": get: summary: List public organization events description: |- > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: 200-response: "$ref": "#/components/examples/public-org-events-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/orgs/{org}/external-group/{group_id}": get: summary: Get an external group description: |- 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. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/external-idp-group-info-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/group-id" - "$ref": "#/components/parameters/members-per-page" - "$ref": "#/components/parameters/members-page" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/external-group" examples: default: "$ref": "#/components/examples/external-group" x-github: githubCloudOnly: true enabledForGitHubApps: true category: teams subcategory: external-groups "/orgs/{org}/external-groups": get: summary: List external groups available to an organization description: |- Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/list-external-idp-groups-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - name: page description: Page token in: query schema: type: integer - name: display_name description: Limits the list to groups containing the text in the group name in: query schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/external-groups" examples: default: "$ref": "#/components/examples/external-groups" headers: Link: example: ; rel="next" schema: type: string x-github: githubCloudOnly: true enabledForGitHubApps: true category: teams subcategory: external-groups "/orgs/{org}/failed_invitations": get: summary: List failed organization invitations description: "The return hash contains `failed_at` and `failed_reason` fields which \nrepresent the time at which the invitation failed and the reason for the failure.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." tags: - orgs operationId: orgs/list-failed-invitations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-invitation" examples: default: "$ref": "#/components/examples/organization-invitation-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/fine_grained_permissions": get: summary: Closing down - List fine-grained permissions for an organization description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/list-fine-grained-permissions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-fine-grained-permission" examples: default: "$ref": "#/components/examples/repository-fine-grained-permission-example" x-github: githubCloudOnly: true enabledForGitHubApps: true removalDate: '2022-09-06' deprecationDate: '2023-03-06' category: orgs subcategory: custom-roles deprecated: true "/orgs/{org}/hooks": get: summary: List organization webhooks description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/list-webhooks externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/org-hook" examples: default: "$ref": "#/components/examples/org-hook-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks post: summary: Create an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/create-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Must be passed as "web". config: type: object description: Key/value pairs to provide settings for this webhook. properties: url: "$ref": "#/components/schemas/webhook-config-url" content_type: "$ref": "#/components/schemas/webhook-config-content-type" secret: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" username: type: string example: '"kdaigle"' password: type: string example: '"password"' required: - url events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. default: - push items: type: string active: type: boolean description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. default: true required: - name - config examples: default: value: name: web active: true events: - push - pull_request config: url: http://example.com/webhook content_type: json responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/org-hook" examples: default: "$ref": "#/components/examples/org-hook" headers: Location: example: https://api.github.com/orgs/octocat/hooks/1 schema: type: string '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/get-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/org-hook" examples: default: "$ref": "#/components/examples/org-hook" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks patch: summary: Update an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/update-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" requestBody: required: false content: application/json: schema: type: object properties: config: type: object description: Key/value pairs to provide settings for this webhook. properties: url: "$ref": "#/components/schemas/webhook-config-url" content_type: "$ref": "#/components/schemas/webhook-config-content-type" secret: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" required: - url events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. default: - push items: type: string active: type: boolean description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. default: true name: type: string example: '"web"' examples: default: value: active: true events: - pull_request responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/org-hook" examples: default: "$ref": "#/components/examples/org-hook-2" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks delete: summary: Delete an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/delete-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/get-webhook-config-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/webhook-config" examples: default: "$ref": "#/components/examples/webhook-config" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks patch: summary: Update a webhook configuration for an organization description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/update-webhook-config-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" requestBody: required: false content: application/json: schema: type: object properties: url: "$ref": "#/components/schemas/webhook-config-url" content_type: "$ref": "#/components/schemas/webhook-config-content-type" secret: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" examples: default: summary: Update an existing webhook value: url: http://example.com/webhook content_type: json insecure_ssl: '0' secret: "********" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/webhook-config" examples: default: "$ref": "#/components/examples/webhook-config" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/list-webhook-deliveries externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/hook-delivery-item" examples: default: "$ref": "#/components/examples/hook-delivery-items" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/get-webhook-delivery externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/delivery-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/hook-delivery" examples: default: "$ref": "#/components/examples/hook-delivery" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/redeliver-webhook-delivery externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/delivery-id" responses: '202': "$ref": "#/components/responses/accepted" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook description: |- You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. tags: - orgs operationId: orgs/ping-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/hook-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: webhooks "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": get: summary: Get route stats by actor description: Get API request count statistics for an actor broken down by route within a specified time frame. tags: - orgs operationId: api-insights/get-route-stats-by-actor externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-actor-type" - "$ref": "#/components/parameters/api-insights-actor-id" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-route-stats-sort" - "$ref": "#/components/parameters/api-insights-api-route-substring" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-route-stats" examples: default: "$ref": "#/components/examples/api-insights-route-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/subject-stats": get: summary: Get subject stats description: Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. tags: - orgs operationId: api-insights/get-subject-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-sort" - "$ref": "#/components/parameters/api-insights-subject-name-substring" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-subject-stats" examples: default: "$ref": "#/components/examples/api-insights-subject-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/summary-stats": get: summary: Get summary stats description: Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. tags: - orgs operationId: api-insights/get-summary-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-summary-stats" examples: default: "$ref": "#/components/examples/api-insights-summary-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/summary-stats/users/{user_id}": get: summary: Get summary stats by user description: Get overall statistics of API requests within the organization for a user. tags: - orgs operationId: api-insights/get-summary-stats-by-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-user-id" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-summary-stats" examples: default: "$ref": "#/components/examples/api-insights-summary-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": get: summary: Get summary stats by actor description: Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. tags: - orgs operationId: api-insights/get-summary-stats-by-actor externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" - "$ref": "#/components/parameters/api-insights-actor-type" - "$ref": "#/components/parameters/api-insights-actor-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-summary-stats" examples: default: "$ref": "#/components/examples/api-insights-summary-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/time-stats": get: summary: Get time stats description: Get the number of API requests and rate-limited requests made within an organization over a specified time period. tags: - orgs operationId: api-insights/get-time-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" - "$ref": "#/components/parameters/api-insights-timestamp-increment" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-time-stats" examples: default: "$ref": "#/components/examples/api-insights-time-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/time-stats/users/{user_id}": get: summary: Get time stats by user description: Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. tags: - orgs operationId: api-insights/get-time-stats-by-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-user-id" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" - "$ref": "#/components/parameters/api-insights-timestamp-increment" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-time-stats" examples: default: "$ref": "#/components/examples/api-insights-time-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": get: summary: Get time stats by actor description: Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. tags: - orgs operationId: api-insights/get-time-stats-by-actor externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-actor-type" - "$ref": "#/components/parameters/api-insights-actor-id" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" - "$ref": "#/components/parameters/api-insights-timestamp-increment" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-time-stats" examples: default: "$ref": "#/components/examples/api-insights-time-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/insights/api/user-stats/{user_id}": get: summary: Get user stats description: Get API usage statistics within an organization for a user broken down by the type of access. tags: - orgs operationId: api-insights/get-user-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/api-insights-user-id" - "$ref": "#/components/parameters/api-insights-min-timestamp" - "$ref": "#/components/parameters/api-insights-max-timestamp" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-sort" - "$ref": "#/components/parameters/api-insights-actor-name-substring" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/api-insights-user-stats" examples: default: "$ref": "#/components/examples/api-insights-user-stats" x-github: enabledForGitHubApps: true category: orgs subcategory: api-insights "/orgs/{org}/installation": get: summary: Get an organization installation for the authenticated app description: |- Enables an authenticated GitHub App to find the organization's installation information. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-org-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/installation" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps "/orgs/{org}/installations": get: summary: List app installations for an organization description: |- Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. tags: - orgs operationId: orgs/list-app-installations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - installations properties: total_count: type: integer installations: type: array items: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/installation-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/interaction-limits": get: summary: Get interaction restrictions for an organization description: Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. tags: - interactions operationId: interactions/get-restrictions-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: anyOf: - "$ref": "#/components/schemas/interaction-limit-response" - type: object properties: {} additionalProperties: false examples: default: "$ref": "#/components/examples/interaction-limit-response" x-github: githubCloudOnly: false enabledForGitHubApps: true category: interactions subcategory: orgs put: summary: Set interaction restrictions for an organization description: Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. tags: - interactions operationId: interactions/set-restrictions-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/interaction-limit" examples: default: value: limit: collaborators_only expiry: one_month responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/interaction-limit-response" examples: default: "$ref": "#/components/examples/interaction-limit-response" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: interactions subcategory: orgs delete: summary: Remove interaction restrictions for an organization description: Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. tags: - interactions operationId: interactions/remove-restrictions-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: interactions subcategory: orgs "/orgs/{org}/invitations": get: summary: List pending organization invitations description: |- The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-pending-invitations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: role description: Filter invitations by their member role. in: query required: false schema: type: string enum: - all - admin - direct_member - billing_manager - hiring_manager default: all - name: invitation_source description: Filter invitations by their invitation source. in: query required: false schema: type: string enum: - all - member - scim default: all responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-invitation" examples: default: "$ref": "#/components/examples/organization-invitation-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members post: summary: Create an organization invitation description: |- Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. tags: - orgs operationId: orgs/create-invitation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - "$ref": "#/components/parameters/org" requestBody: required: false content: application/json: schema: type: object properties: invitee_id: type: integer description: "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." email: type: string description: "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user." role: type: string description: "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization." enum: - admin - direct_member - billing_manager - reinstate default: direct_member team_ids: type: array description: Specify IDs for the teams you want to invite new members to. items: type: integer examples: default: value: email: octocat@github.com role: direct_member team_ids: - 12 - 26 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-invitation" examples: default: "$ref": "#/components/examples/organization-invitation" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/invitations/{invitation_id}": delete: summary: Cancel an organization invitation description: |- Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). tags: - orgs operationId: orgs/cancel-invitation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/invitation-id" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/invitations/{invitation_id}/teams": get: summary: List organization invitation teams description: |- List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). tags: - orgs operationId: orgs/list-invitation-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/invitation-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: default: "$ref": "#/components/examples/team-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/issue-types": get: summary: List issue types for an organization description: Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. tags: - orgs operationId: orgs/list-issue-types externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue-type" examples: default: "$ref": "#/components/examples/issue-type-items" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: issue-types post: summary: Create issue type for an organization description: |- Create a new issue type for an organization. You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/create-issue-type externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-create-issue-type" examples: default: value: name: Epic description: An issue type for a multi-week tracking of work is_enabled: true color: green responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue-type" examples: default: "$ref": "#/components/examples/issue-type" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: issue-types "/orgs/{org}/issue-types/{issue_type_id}": put: summary: Update issue type for an organization description: |- Updates an issue type for an organization. You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/update-issue-type externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/issue-type-id" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-update-issue-type" examples: default: value: name: Epic description: An issue type for a multi-week tracking of work is_enabled: true color: green responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue-type" examples: default: "$ref": "#/components/examples/issue-type" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: issue-types delete: summary: Delete issue type for an organization description: |- Deletes an issue type for an organization. You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/delete-issue-type externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/issue-type-id" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed_simple" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: issue-types "/orgs/{org}/issues": get: summary: List organization issues assigned to the authenticated user description: |- List issues in an organization assigned to the authenticated user. > [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - "$ref": "#/components/parameters/org" - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - "$ref": "#/components/parameters/labels" - name: type description: Can be the name of an issue type. in: query required: false schema: type: string - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue-with-repo-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues "/orgs/{org}/members": get: summary: List organization members description: List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. tags: - orgs operationId: orgs/list-members externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - "$ref": "#/components/parameters/org" - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. in: query required: false schema: type: string enum: - 2fa_disabled - 2fa_insecure - all default: all - name: role description: Filter members returned by their role. in: query required: false schema: type: string enum: - all - admin - member default: all - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/members/{username}": get: summary: Check organization membership for a user description: Check if a user is, publicly or privately, a member of the organization. tags: - orgs operationId: orgs/check-membership-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response if requester is an organization member and user is a member '302': description: Response if requester is not an organization member headers: Location: example: https://api.github.com/orgs/github/public_members/pezra schema: type: string '404': description: Not Found if requester is an organization member and user is not a member x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members delete: summary: Remove an organization member description: |- Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. > [!NOTE] > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. tags: - orgs operationId: orgs/remove-member externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/members/{username}/codespaces": get: summary: List codespaces for a user in organization description: |- Lists the codespaces that a member of an organization has for repositories in that organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-codespaces-for-user-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-a-user-in-organization parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - codespaces properties: total_count: type: integer codespaces: type: array items: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespaces-list" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organizations "/orgs/{org}/members/{username}/codespaces/{codespace_name}": delete: summary: Delete a codespace from the organization description: |- Deletes a user's codespace. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-from-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/codespace-name" responses: '202': "$ref": "#/components/responses/accepted" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organizations "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": post: summary: Stop a codespace for an organization user description: |- Stops a user's codespace. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/stop-in-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/codespace-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: organizations "/orgs/{org}/members/{username}/copilot": get: summary: Get Copilot seat assignment details for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: schema: "$ref": "#/components/schemas/copilot-seat-details" examples: default: "$ref": "#/components/examples/copilot-seat-detail-active" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-user-management "/orgs/{org}/memberships/{username}": get: summary: Get organization membership for a user description: 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. tags: - orgs operationId: orgs/get-membership-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/org-membership" examples: response-if-user-has-an-active-admin-membership-with-organization: "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members put: summary: Set organization membership for a user description: "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period." tags: - orgs operationId: orgs/set-membership-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" requestBody: required: false content: application/json: schema: type: object properties: role: type: string description: "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization." enum: - admin - member default: member examples: default: summary: Set an organization membership role for a user value: role: member responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/org-membership" examples: response-if-user-already-had-membership-with-organization: "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members delete: summary: Remove organization membership for a user description: |- In order to remove a user's membership with an organization, the authenticated user must be an organization owner. If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. > [!NOTE] > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. tags: - orgs operationId: orgs/remove-membership-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/migrations": get: summary: List organization migrations description: |- Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). A list of `repositories` is only returned for export migrations. tags: - migrations operationId: migrations/list-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: exclude description: Exclude attributes from the API response to improve performance in: query schema: type: array items: description: Allowed values that can be passed to the exclude param. enum: - repositories example: repositories type: string responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/migration" examples: default: "$ref": "#/components/examples/migration-with-short-org-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: orgs post: summary: Start an organization migration description: Initiates the generation of a migration archive. tags: - migrations operationId: migrations/start-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: repositories: type: array description: A list of arrays indicating which repositories should be migrated. items: type: string lock_repositories: type: boolean example: true description: Indicates whether repositories should be locked (to prevent manipulation) while migrating data. default: false exclude_metadata: type: boolean description: Indicates whether metadata should be excluded and only git source should be included for the migration. default: false exclude_git_data: type: boolean description: Indicates whether the repository git data should be excluded from the migration. default: false exclude_attachments: type: boolean example: true description: Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). default: false exclude_releases: type: boolean example: true description: Indicates whether releases should be excluded from the migration (to reduce migration archive file size). default: false exclude_owner_projects: type: boolean example: true description: Indicates whether projects owned by the organization or users should be excluded. from the migration. default: false org_metadata_only: type: boolean example: true description: Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). default: false exclude: type: array description: Exclude related items from being returned in the response in order to improve performance of the request. items: type: string enum: - repositories required: - repositories examples: default: value: repositories: - github/Hello-World lock_repositories: true responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/migration" examples: default: "$ref": "#/components/examples/migration-with-short-org-2" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: orgs "/orgs/{org}/migrations/{migration_id}": get: summary: Get an organization migration status description: |- Fetches the status of a migration. The `state` of a migration can be one of the following values: * `pending`, which means the migration hasn't started yet. * `exporting`, which means the migration is in progress. * `exported`, which means the migration finished successfully. * `failed`, which means the migration failed. tags: - migrations operationId: migrations/get-status-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/migration-id" - name: exclude description: Exclude attributes from the API response to improve performance in: query schema: type: array items: description: Allowed values that can be passed to the exclude param. enum: - repositories example: repositories type: string responses: '200': description: |- * `pending`, which means the migration hasn't started yet. * `exporting`, which means the migration is in progress. * `exported`, which means the migration finished successfully. * `failed`, which means the migration failed. content: application/json: schema: "$ref": "#/components/schemas/migration" examples: default: "$ref": "#/components/examples/migration-with-short-org" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: orgs "/orgs/{org}/migrations/{migration_id}/archive": get: summary: Download an organization migration archive description: Fetches the URL to a migration archive. tags: - migrations operationId: migrations/download-archive-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/migration-id" responses: '302': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: orgs delete: summary: Delete an organization migration archive description: Deletes a previous migration archive. Migration archives are automatically deleted after seven days. tags: - migrations operationId: migrations/delete-archive-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/migration-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: orgs "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": delete: summary: Unlock an organization repository description: Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. tags: - migrations operationId: migrations/unlock-repo-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/migration-id" - "$ref": "#/components/parameters/repo-name" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: orgs "/orgs/{org}/migrations/{migration_id}/repositories": get: summary: List repositories in an organization migration description: List all the repositories for this organization migration. tags: - migrations operationId: migrations/list-repos-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/migration-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: orgs "/orgs/{org}/organization-fine-grained-permissions": get: summary: List organization fine-grained permissions for an organization description: |- Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-organization-fine-grained-permissions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-fine-grained-permission" examples: default: "$ref": "#/components/examples/organization-fine-grained-permission-example" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles": get: summary: Get all organization roles for an organization description: |- Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-roles externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response - list of organization roles content: application/json: schema: type: object properties: total_count: type: integer description: The total number of organization roles available to the organization. roles: type: array description: The list of organization roles available to the organization. items: "$ref": "#/components/schemas/organization-role" examples: default: "$ref": "#/components/examples/organization-role-list" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles post: summary: Create a custom organization role description: |- Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization and optionally across all repositories in the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To include repository permissions in an organization role, you must also include the `base_role` field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of fine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions and can only be granted through the base role (like "reading a repo"). If you include repository permissions, those permissions apply across all of the repositories in the organization. You do not have to include organization permissions in order to add repository permissions. See "[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/create-custom-organization-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-custom-organization-role-create-schema" examples: default: value: name: Custom Role Manager description: Permissions to manage custom roles within an org permissions: - write_organization_custom_repo_role - write_organization_custom_org_role - read_organization_custom_repo_role - read_organization_custom_org_role responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-role" examples: default: value: id: 8030 name: Custom Role Manager description: Permissions to manage custom roles within an org permissions: - write_organization_custom_repo_role - write_organization_custom_org_role - read_organization_custom_repo_role - read_organization_custom_org_role organization: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events hooks_url: https://api.github.com/orgs/github/hooks issues_url: https://api.github.com/orgs/github/issues members_url: https://api.github.com/orgs/github/members{/member} public_members_url: https://api.github.com/orgs/github/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles/teams/{team_slug}": delete: summary: Remove all organization roles for a team description: |- Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-all-org-roles-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": put: summary: Assign an organization role to a team description: |- Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/assign-team-to-org-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response '404': description: Response if the organization, team or role does not exist. '422': description: Response if the organization roles feature is not enabled for the organization, or validation failed. x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles delete: summary: Remove an organization role from a team description: |- Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-org-role-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles/users/{username}": delete: summary: Remove all organization roles for a user description: |- Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-all-org-roles-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles/users/{username}/{role_id}": put: summary: Assign an organization role to a user description: |- Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/assign-user-to-org-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response '404': description: Response if the organization, user or role does not exist. '422': description: Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles delete: summary: Remove an organization role from a user description: |- Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-org-role-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles/{role_id}": get: summary: Get an organization role description: |- Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/get-org-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-role" examples: default: "$ref": "#/components/examples/organization-role" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles patch: summary: Update a custom organization role description: |- Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either previously or as part of the update. If the update sets the `base_role` field to `none`, you must also remove all of the repository permissions as well, otherwise the update will fail. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/patch-custom-organization-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/organization-custom-organization-role-update-schema" examples: default: value: description: Permissions to manage custom roles within an org. responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/organization-role" examples: default: value: id: 8030 name: Custom Role Manager description: Permissions to manage custom roles within an org permissions: - write_organization_custom_repo_role - write_organization_custom_org_role - read_organization_custom_repo_role - read_organization_custom_org_role organization: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events hooks_url: https://api.github.com/orgs/github/hooks issues_url: https://api.github.com/orgs/github/issues members_url: https://api.github.com/orgs/github/members{/member} public_members_url: https://api.github.com/orgs/github/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': "$ref": "#/components/responses/validation_failed" '409': "$ref": "#/components/responses/conflict" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: organization-roles delete: summary: Delete a custom organization role. description: |- Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/delete-custom-organization-role externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles/{role_id}/teams": get: summary: List teams that are assigned to an organization role description: |- Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-role-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response - List of assigned teams content: application/json: schema: type: array description: List of teams assigned to the organization role items: "$ref": "#/components/schemas/team-role-assignment" examples: default: "$ref": "#/components/examples/team-items" headers: Link: "$ref": "#/components/headers/link" '404': description: Response if the organization or role does not exist. '422': description: Response if the organization roles feature is not enabled or validation failed. x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/organization-roles/{role_id}/users": get: summary: List users that are assigned to an organization role description: |- Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." To use this endpoint, you must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-role-users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/role-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response - List of assigned users content: application/json: schema: type: array description: List of users assigned to the organization role items: "$ref": "#/components/schemas/user-role-assignment" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" '404': description: Response if the organization or role does not exist. '422': description: Response if the organization roles feature is not enabled or validation failed. x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: organization-roles "/orgs/{org}/outside_collaborators": get: summary: List outside collaborators for an organization description: List all users who are outside collaborators of an organization. tags: - orgs operationId: orgs/list-outside-collaborators externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - "$ref": "#/components/parameters/org" - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. in: query required: false schema: type: string enum: - 2fa_disabled - 2fa_insecure - all default: all - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: outside-collaborators "/orgs/{org}/outside_collaborators/{username}": put: summary: Convert an organization member to outside collaborator description: When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-cloud@latest//articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." tags: - orgs operationId: orgs/convert-member-to-outside-collaborator externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" requestBody: required: false content: application/json: schema: type: object properties: async: type: boolean description: When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. default: false examples: '202': summary: Status code 202, asynchronous request value: async: true '204': summary: Status code 204, synchronous request value: responses: '202': description: User is getting converted asynchronously content: application/json: schema: type: object properties: {} additionalProperties: false examples: '202': value: '204': description: User was converted '403': description: Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: outside-collaborators delete: summary: Remove outside collaborator from an organization description: Removing a user from this list will remove them from all the organization's repositories. tags: - orgs operationId: orgs/remove-outside-collaborator externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response '422': description: Unprocessable Entity if user is a member of the organization content: application/json: schema: type: object properties: message: type: string documentation_url: type: string examples: response-if-user-is-a-member-of-the-organization: value: message: You cannot specify an organization member to remove as an outside collaborator. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: outside-collaborators "/orgs/{org}/packages": get: summary: List packages for an organization description: |- Lists packages in an organization readable by the user. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-an-organization parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. in: query required: true schema: type: string enum: - npm - maven - rubygems - docker - nuget - container - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/package-visibility" - name: page description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/packages-for-org" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '400': "$ref": "#/components/responses/package_es_list_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/orgs/{org}/packages/{package_type}/{package_name}": get: summary: Get a package for an organization description: |- Gets a specific package in an organization. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/package-org" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages delete: summary: Delete a package for an organization description: |- Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. The 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/org" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/orgs/{org}/packages/{package_type}/{package_name}/restore": post: summary: Restore a package for an organization description: |- Restores an entire package in an organization. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. The 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/org" - name: token description: package token schema: type: string required: false in: query responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/orgs/{org}/packages/{package_type}/{package_name}/versions": get: summary: List package versions for a package owned by an organization description: |- Lists package versions for a package owned by an organization. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - name: state in: query required: false description: The state of the package, either active or deleted. schema: type: string enum: - active - deleted default: active responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package-version" examples: default: "$ref": "#/components/examples/package-versions-for-org" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": get: summary: Get a package version for an organization description: |- Gets a specific package version in an organization. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-organization externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/package-version-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/package-version" examples: default: "$ref": "#/components/examples/package-version-org" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages delete: summary: Delete package version for an organization description: |- Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. The 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/package-version-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": post: summary: Restore package version for an organization description: |- Restores a specific package version in an organization. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. The 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/package-version-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/orgs/{org}/personal-access-token-requests": get: summary: List requests to access organization resources with fine-grained personal access tokens description: |- Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/personal-access-token-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/personal-access-token-owner" - "$ref": "#/components/parameters/personal-access-token-repository" - "$ref": "#/components/parameters/personal-access-token-permission" - "$ref": "#/components/parameters/personal-access-token-before" - "$ref": "#/components/parameters/personal-access-token-after" - "$ref": "#/components/parameters/personal-access-token-token-id" responses: '500': "$ref": "#/components/responses/internal_error" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-programmatic-access-grant-request" examples: default: "$ref": "#/components/examples/org-pat-grant-request-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens post: summary: Review requests to access organization resources with fine-grained personal access tokens description: |- Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/review-pat-grant-requests-in-bulk externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: pat_request_ids: type: array description: Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. items: type: integer minItems: 1 maxItems: 100 action: type: string description: Action to apply to the requests. enum: - approve - deny reason: type: string description: Reason for approving or denying the requests. Max 1024 characters. maxLength: 1024 nullable: true required: - action examples: '204': summary: Example of denying a request value: pat_request_ids: - 42 - 73 action: deny reason: Access is too broad. responses: '500': "$ref": "#/components/responses/internal_error" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '202': "$ref": "#/components/responses/accepted" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens "/orgs/{org}/personal-access-token-requests/{pat_request_id}": post: summary: Review a request to access organization resources with a fine-grained personal access token description: |- Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/review-pat-grant-request externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - "$ref": "#/components/parameters/org" - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained personal access token. required: true schema: type: integer requestBody: required: true content: application/json: schema: type: object properties: action: type: string description: Action to apply to the request. enum: - approve - deny reason: type: string description: Reason for approving or denying the request. Max 1024 characters. maxLength: 1024 nullable: true required: - action examples: '204': summary: Example of denying a request value: action: deny reason: This request is denied because the access is too broad. responses: '500': "$ref": "#/components/responses/internal_error" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '204': "$ref": "#/components/responses/no_content" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": get: summary: List repositories requested to be accessed by a fine-grained personal access token description: |- Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-request-repositories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - "$ref": "#/components/parameters/org" - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained personal access token. required: true schema: type: integer - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '500': "$ref": "#/components/responses/internal_error" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens "/orgs/{org}/personal-access-tokens": get: summary: List fine-grained personal access tokens with access to organization resources description: |- Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grants externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/personal-access-token-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/personal-access-token-owner" - "$ref": "#/components/parameters/personal-access-token-repository" - "$ref": "#/components/parameters/personal-access-token-permission" - "$ref": "#/components/parameters/personal-access-token-before" - "$ref": "#/components/parameters/personal-access-token-after" - "$ref": "#/components/parameters/personal-access-token-token-id" responses: '500': "$ref": "#/components/responses/internal_error" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-programmatic-access-grant" examples: default: "$ref": "#/components/examples/org-pat-grant-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens post: summary: Update the access to organization resources via fine-grained personal access tokens description: |- Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/update-pat-accesses externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: action: type: string description: Action to apply to the fine-grained personal access token. enum: - revoke pat_ids: description: The IDs of the fine-grained personal access tokens. type: array items: type: integer description: Unique identifier of the fine-grained personal access token. minItems: 1 maxItems: 100 required: - action - pat_ids examples: '204': summary: Example of revoking a fine-grained personal access token. value: action: revoke pat_ids: - 1296269 - 1296280 responses: '500': "$ref": "#/components/responses/internal_error" '404': "$ref": "#/components/responses/not_found" '202': "$ref": "#/components/responses/accepted" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens "/orgs/{org}/personal-access-tokens/{pat_id}": post: summary: Update the access a fine-grained personal access token has to organization resources description: |- Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/update-pat-access externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/fine-grained-personal-access-token-id" requestBody: required: true content: application/json: schema: type: object properties: action: type: string description: Action to apply to the fine-grained personal access token. enum: - revoke required: - action examples: '204': summary: Example of revoking a fine-grained personal access token. value: action: revoke responses: '500': "$ref": "#/components/responses/internal_error" '404': "$ref": "#/components/responses/not_found" '204': "$ref": "#/components/responses/no_content" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": get: summary: List repositories a fine-grained personal access token has access to description: |- Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-repositories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - "$ref": "#/components/parameters/org" - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. required: true schema: type: integer - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '500': "$ref": "#/components/responses/internal_error" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens "/orgs/{org}/private-registries": get: summary: List private registries for an organization description: |2- Lists all private registry configurations available at the organization-level without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - private-registries operationId: private-registries/list-org-private-registries externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - configurations properties: total_count: type: integer configurations: type: array items: "$ref": "#/components/schemas/org-private-registry-configuration" examples: default: "$ref": "#/components/examples/org-private-registry-configurations-paginated" headers: Link: "$ref": "#/components/headers/link" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: private-registries subcategory: organization-configurations post: summary: Create a private registry for an organization description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - private-registries operationId: private-registries/create-org-private-registry externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: registry_type: description: The registry type. type: string enum: - maven_repository - nuget_feed - goproxy_server - npm_registry - rubygems_server - cargo_registry - composer_repository - docker_registry - git_source - helm_registry - hex_organization - hex_repository - pub_repository - python_index - terraform_registry url: description: The URL of the private registry. type: string format: uri username: description: The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. type: string nullable: true replaces_base: description: Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. type: boolean default: false encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. type: string pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: description: The ID of the key you used to encrypt the secret. type: string visibility: description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. type: string enum: - all - private - selected selected_repository_ids: description: An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. type: array items: type: integer required: - registry_type - url - encrypted_value - key_id - visibility examples: org-private-registry-with-private-visibility: summary: Example of a private registry configuration with private visibility value: registry_type: maven_repository url: https://maven.pkg.github.com/organization/ username: monalisa replaces_base: true encrypted_value: c2VjcmV0 key_id: '012345678912345678' visibility: private org-private-registry-with-selected-visibility: summary: Example of a private registry configuration with selected visibility value: registry_type: maven_repository url: https://maven.pkg.github.com/organization/ username: monalisa encrypted_value: c2VjcmV0 key_id: '012345678912345678' visibility: selected selected_repository_ids: - 1296269 - 1296280 responses: '201': description: The organization private registry configuration content: application/json: schema: "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" examples: org-private-registry-with-selected-visibility: "$ref": "#/components/examples/org-private-registry-configuration" org-private-registry-with-private-visibility: "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: private-registries subcategory: organization-configurations "/orgs/{org}/private-registries/public-key": get: summary: Get private registries public key for an organization description: |2- 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. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - private-registries operationId: private-registries/get-org-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: object required: - key_id - key properties: key_id: description: The identifier for the key. example: '012345678912345678' type: string key: description: The Base64 encoded public key. example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 type: string examples: default: "$ref": "#/components/examples/private-registries-public-key" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: private-registries subcategory: organization-configurations "/orgs/{org}/private-registries/{secret_name}": get: summary: Get a private registry for an organization description: |2- Get the configuration of a single private registry defined for an organization, omitting its encrypted value. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - private-registries operationId: private-registries/get-org-private-registry externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '200': description: The specified private registry configuration for the organization content: application/json: schema: "$ref": "#/components/schemas/org-private-registry-configuration" examples: default: "$ref": "#/components/examples/org-private-registry-configuration" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: private-registries subcategory: organization-configurations patch: summary: Update a private registry for an organization description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - private-registries operationId: private-registries/update-org-private-registry externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: registry_type: description: The registry type. type: string enum: - maven_repository - nuget_feed - goproxy_server - npm_registry - rubygems_server - cargo_registry - composer_repository - docker_registry - git_source - helm_registry - hex_organization - hex_repository - pub_repository - python_index - terraform_registry url: description: The URL of the private registry. type: string format: uri username: description: The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. type: string nullable: true replaces_base: description: Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. type: boolean default: false encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. type: string pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: description: The ID of the key you used to encrypt the secret. type: string visibility: description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. type: string enum: - all - private - selected selected_repository_ids: description: An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. type: array items: type: integer examples: default: value: username: monalisa encrypted_value: c2VjcmV0 key_id: '012345678912345678' responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: private-registries subcategory: organization-configurations delete: summary: Delete a private registry for an organization description: |2- Delete a private registry configuration at the organization-level. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - private-registries operationId: private-registries/delete-org-private-registry externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: private-registries subcategory: organization-configurations "/orgs/{org}/projectsV2": get: summary: List projects for organization description: List all projects owned by a specific organization accessible by the authenticated user. tags: - projects operationId: projects/list-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization parameters: - "$ref": "#/components/parameters/org" - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/projects-v2" examples: default: "$ref": "#/components/examples/projects-v2" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: projects "/orgs/{org}/projectsV2/{project_number}": get: summary: Get project for organization description: Get a specific organization-owned project. tags: - projects operationId: projects/get-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2" examples: default: "$ref": "#/components/examples/projects-v2" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: projects "/orgs/{org}/projectsV2/{project_number}/drafts": post: summary: Create draft item for organization owned project description: Create draft issue item for the specified organization owned project. tags: - projects operationId: projects/create-draft-item-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/project-number" requestBody: required: true description: Details of the draft item to create in the project. content: application/json: schema: type: object properties: title: type: string description: The title of the draft issue item to create in the project. body: type: string description: The body content of the draft issue item to create in the project. required: - title examples: title: summary: Example with Sample Draft Issue Title value: title: Sample Draft Issue Title body: summary: Example with Sample Draft Issue Title and Body value: title: Sample Draft Issue Title body: This is the body content of the draft issue. responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: draft_issue: "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: drafts "/orgs/{org}/projectsV2/{project_number}/fields": get: summary: List project fields for organization description: List all fields for a specific organization-owned project. tags: - projects operationId: projects/list-fields-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/projects-v2-field" examples: default: "$ref": "#/components/examples/projects-v2-field-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: fields "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for organization description: Get a specific field for an organization-owned project. tags: - projects operationId: projects/get-field-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/field-id" - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-field" examples: default: "$ref": "#/components/examples/projects-v2-field" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: fields "/orgs/{org}/projectsV2/{project_number}/items": get: summary: List items for an organization owned project description: List all items for a specific organization-owned project accessible by the authenticated user. tags: - projects operationId: projects/list-items-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/org" - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. in: query required: false schema: type: string - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: oneOf: - type: string - type: array maxItems: 50 items: type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/projects-v2-item-with-content" examples: default: "$ref": "#/components/examples/projects-v2-item-with-content" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items post: summary: Add item to organization owned project description: Add an issue or pull request item to the specified organization owned project. tags: - projects operationId: projects/add-item-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/project-number" requestBody: required: true description: Details of the item to add to the project. content: application/json: schema: type: object properties: type: type: string enum: - Issue - PullRequest description: The type of item to add to the project. Must be either Issue or PullRequest. id: type: integer description: The numeric ID of the issue or pull request to add to the project. required: - type - id examples: issue: value: type: Issue id: 3 pull_request: value: type: PullRequest id: 3 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: issue: "$ref": "#/components/examples/projects-v2-item-simple" pull_request: "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": get: summary: Get an item for an organization owned project description: Get a specific item from an organization-owned project. tags: - projects operationId: projects/get-org-item externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: oneOf: - type: string - type: array maxItems: 50 items: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-with-content" examples: default: "$ref": "#/components/examples/projects-v2-item-with-content" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items patch: summary: Update project item for organization description: Update a specific item in an organization-owned project. tags: - projects operationId: projects/update-item-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" requestBody: required: true description: Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. content: application/json: schema: type: object properties: fields: type: array description: A list of field updates to apply. items: type: object properties: id: type: integer description: The ID of the project field to update. value: description: |- The new value for the field: - For text, number, and date fields, provide the new value directly. - For single select and iteration fields, provide the ID of the option or iteration. - To clear the field, set this to null. nullable: true oneOf: - type: string - type: number required: - id - value required: - fields examples: text_field: summary: Update a text field value: fields: - id: 123 value: Updated text value number_field: summary: Update a number field value: fields: - id: 456 value: 42.5 date_field: summary: Update a date field value: fields: - id: 789 value: '2023-10-05' single_select_field: summary: Update a single select field value: fields: - id: 789 value: 47fc9ee4 iteration_field: summary: Update an iteration field value: fields: - id: 1011 value: 866ee5b8 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-with-content" examples: text_field: "$ref": "#/components/examples/projects-v2-item-with-content" number_field: "$ref": "#/components/examples/projects-v2-item-with-content" date_field: "$ref": "#/components/examples/projects-v2-item-with-content" single_select_field: "$ref": "#/components/examples/projects-v2-item-with-content" iteration_field: "$ref": "#/components/examples/projects-v2-item-with-content" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items delete: summary: Delete project item for organization description: Delete a specific item from an organization-owned project. tags: - projects operationId: projects/delete-item-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/item-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items "/orgs/{org}/properties/schema": get: summary: Get all custom properties for an organization description: |- Gets all custom properties defined for an organization. Organization members can read these properties. tags: - orgs operationId: orgs/custom-properties-for-repos-get-organization-definitions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties patch: summary: Create or update custom properties for an organization description: |- Creates new or updates existing custom properties defined for an organization in a batch. If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/custom-properties-for-repos-create-or-update-organization-definitions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: properties: type: array description: The array of custom properties to create or update. items: "$ref": "#/components/schemas/custom-property" minItems: 1 maxItems: 100 required: - properties examples: default: value: properties: - property_name: environment value_type: single_select required: true default_value: production description: Prod or dev environment allowed_values: - production - development values_editable_by: org_actors - property_name: service value_type: string - property_name: team value_type: string description: Team owning the repository responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties "/orgs/{org}/properties/schema/{custom_property_name}": get: summary: Get a custom property for an organization description: |- Gets a custom property that is defined for an organization. Organization members can read these properties. tags: - orgs operationId: orgs/custom-properties-for-repos-get-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/custom-property-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties put: summary: Create or update a custom property for an organization description: |- Creates a new or updates an existing custom property that is defined for an organization. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/custom-properties-for-repos-create-or-update-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/custom-property-name" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: value_type: single_select required: true default_value: production description: Prod or dev environment allowed_values: - production - development responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/custom-property" examples: default: "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties delete: summary: Remove a custom property for an organization description: |- Removes a custom property that is defined for an organization. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/custom-properties-for-repos-delete-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/custom-property-name" responses: '204': "$ref": "#/components/responses/no_content" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties "/orgs/{org}/properties/values": get: summary: List custom property values for organization repositories description: |- Lists organization repositories with all of their custom property values. Organization members can read these properties. tags: - orgs operationId: orgs/custom-properties-for-repos-get-organization-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: repository_query description: Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/org-repo-custom-property-values" examples: default: "$ref": "#/components/examples/org-repo-custom-property-values" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties patch: summary: Create or update custom property values for organization repositories description: |- Create new or update existing custom property values for repositories in a batch that belong to an organization. Each target repository will have its custom property values updated to match the values provided in the request. A maximum of 30 repositories can be updated in a single request. Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. tags: - orgs operationId: orgs/custom-properties-for-repos-create-or-update-organization-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: repository_names: type: array description: The names of repositories that the custom property values will be applied to. items: type: string minItems: 1 maxItems: 30 properties: type: array description: List of custom property names and associated values to apply to the repositories. items: "$ref": "#/components/schemas/custom-property-value" required: - repository_names - properties examples: default: "$ref": "#/components/examples/org-repo-update-custom-property-values" responses: '204': description: No Content when custom property values are successfully created or updated '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: custom-properties "/orgs/{org}/public_members": get: summary: List public organization members description: Members of an organization can choose to have their membership publicized or not. tags: - orgs operationId: orgs/list-public-members externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/orgs/{org}/public_members/{username}": get: summary: Check public organization membership for a user description: Check if the provided user is a public member of the organization. tags: - orgs operationId: orgs/check-public-membership-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response if user is a public member '404': description: Not Found if user is not a public member x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members put: summary: Set public organization membership for the authenticated user description: |- The user can publicize their own membership. (A user cannot publicize the membership for another user.) Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." tags: - orgs operationId: orgs/set-public-membership-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: orgs subcategory: members delete: summary: Remove public organization membership for the authenticated user description: Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. tags: - orgs operationId: orgs/remove-public-membership-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: orgs subcategory: members "/orgs/{org}/repos": get: summary: List organization repositories description: |- Lists repositories for the specified organization. > [!NOTE] > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." tags: - repos operationId: repos/list-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - "$ref": "#/components/parameters/org" - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation access token. in: query required: false schema: type: string enum: - all - private - forks - sources - member - internal - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated - pushed - full_name default: created - name: direction description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.' in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos post: summary: Create an organization repository description: |- Creates a new repository in the specified organization. The authenticated user must be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the repository. description: type: string description: A short description of the repository. homepage: type: string description: A URL with more information about the repository. private: type: boolean description: Whether the repository is private. default: false visibility: type: string description: The visibility of the repository. enum: - public - private - internal has_issues: type: boolean description: Either `true` to enable issues for this repository or `false` to disable them. default: true has_projects: type: boolean description: Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. default: true has_wiki: type: boolean description: Either `true` to enable the wiki for this repository or `false` to disable it. default: true has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true is_template: type: boolean description: Either `true` to make this repo available as a template repository or `false` to prevent it. default: false team_id: type: integer description: The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. auto_init: type: boolean description: Pass `true` to create an initial commit with empty README. default: false gitignore_template: type: string description: Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". license_template: type: string description: Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-cloud@latest//articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". allow_squash_merge: type: boolean description: Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. default: true allow_merge_commit: type: boolean description: Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. default: true allow_rebase_merge: type: boolean description: Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. default: true allow_auto_merge: type: boolean description: Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. default: false delete_branch_on_merge: type: boolean description: Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** default: false use_squash_pr_title_as_default: type: boolean description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- Required when using `squash_merge_commit_message`. The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- Required when using `merge_commit_message`. The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. custom_properties: type: object description: The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true required: - name examples: default: value: name: Hello-World description: This is your first repository homepage: https://github.com private: false has_issues: true has_projects: true has_wiki: true responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/full-repository" examples: default: "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World schema: type: string '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/orgs/{org}/repository-fine-grained-permissions": get: summary: List repository fine-grained permissions for an organization description: |- Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/list-repo-fine-grained-permissions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-fine-grained-permission" examples: default: "$ref": "#/components/examples/repository-fine-grained-permission-example" x-github: githubCloudOnly: true enabledForGitHubApps: true category: orgs subcategory: custom-roles "/orgs/{org}/rulesets": get: summary: Get all organization repository rulesets description: Get all the repository rulesets for an organization. tags: - repos operationId: repos/get-org-rulesets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-all-organization-repository-rulesets x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rules parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/ruleset-targets" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/org-ruleset-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. tags: - repos operationId: repos/create-org-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#create-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rules parameters: - "$ref": "#/components/parameters/org" requestBody: description: Request body required: true content: application/json: schema: type: object properties: name: type: string description: The name of the ruleset. target: type: string description: The target of the ruleset enum: - branch - tag - push - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: type: array description: The actors that can bypass the rules in this ruleset items: "$ref": "#/components/schemas/repository-ruleset-bypass-actor" conditions: "$ref": "#/components/schemas/org-ruleset-conditions" rules: type: array description: An array of rules within the ruleset. items: "$ref": "#/components/schemas/org-rules" required: - name - enforcement examples: default: value: name: super cool ruleset target: branch enforcement: active bypass_actors: - actor_id: 234 actor_type: Team bypass_mode: always conditions: ref_name: include: - refs/heads/main - refs/heads/master exclude: - refs/heads/dev* repository_name: include: - important_repository - another_important_repository exclude: - unimportant_repository protected: true rules: - type: commit_author_email_pattern parameters: operator: contains pattern: github responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/org-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites description: |- Lists suites of rule evaluations at the organization level. For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-org-rule-suites externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/ref-in-query" - "$ref": "#/components/parameters/repository-name-in-query" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/actor-name-in-query" - "$ref": "#/components/parameters/rule-suite-result" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/rule-suites" examples: default: "$ref": "#/components/examples/rule-suite-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rule-suites "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": get: summary: Get an organization rule suite description: |- Gets information about a suite of rule evaluations from within an organization. For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-org-rule-suite externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/rule-suite-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/rule-suite" examples: default: "$ref": "#/components/examples/rule-suite" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rule-suites "/orgs/{org}/rulesets/{ruleset_id}": get: summary: Get an organization repository ruleset description: |- Get a repository ruleset for an organization. **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user making the API request has write access to the ruleset. tags: - repos operationId: repos/get-org-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rules parameters: - "$ref": "#/components/parameters/org" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/org-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. tags: - repos operationId: repos/update-org-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#update-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rules parameters: - "$ref": "#/components/parameters/org" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer requestBody: description: Request body required: false content: application/json: schema: type: object properties: name: type: string description: The name of the ruleset. target: type: string description: The target of the ruleset enum: - branch - tag - push - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: type: array description: The actors that can bypass the rules in this ruleset items: "$ref": "#/components/schemas/repository-ruleset-bypass-actor" conditions: "$ref": "#/components/schemas/org-ruleset-conditions" rules: description: An array of rules within the ruleset. type: array items: "$ref": "#/components/schemas/org-rules" examples: default: value: name: super cool ruleset target: branch enforcement: active bypass_actors: - actor_id: 234 actor_type: Team bypass_mode: always conditions: ref_name: include: - refs/heads/main - refs/heads/master exclude: - refs/heads/dev* repository_name: include: - important_repository - another_important_repository exclude: - unimportant_repository protected: true rules: - type: commit_author_email_pattern parameters: operator: contains pattern: github responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/org-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. tags: - repos operationId: repos/delete-org-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#delete-an-organization-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rules parameters: - "$ref": "#/components/parameters/org" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history description: Get the history of an organization ruleset. tags: - orgs operationId: orgs/get-org-ruleset-history externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/ruleset-version" examples: default: "$ref": "#/components/examples/ruleset-history" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rules "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": get: summary: Get organization ruleset version description: Get a version of an organization ruleset. tags: - orgs operationId: orgs/get-org-ruleset-version externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - "$ref": "#/components/parameters/org" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer - name: version_id description: The ID of the version in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/ruleset-version-with-state" examples: default: "$ref": "#/components/examples/org-ruleset-version-with-state" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: rules "/orgs/{org}/secret-scanning/alerts": get: summary: List secret scanning alerts for an organization description: |- Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning operationId: secret-scanning/list-alerts-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" - "$ref": "#/components/parameters/secret-scanning-alert-validity" - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-secret-scanning-alert" examples: default: "$ref": "#/components/examples/organization-secret-scanning-alert-list" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations description: |- Lists the secret scanning pattern configurations for an organization. Personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/list-org-pattern-configs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: push-protection parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-pattern-configuration" examples: default: "$ref": "#/components/examples/secret-scanning-pattern-configuration" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" patch: summary: Update organization pattern configurations description: |- Updates the secret scanning pattern configurations for an organization. Personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/update-org-pattern-configs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: push-protection parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: pattern_config_version: "$ref": "#/components/schemas/secret-scanning-row-version" provider_pattern_settings: type: array description: Pattern settings for provider patterns. items: type: object properties: token_type: type: string description: The ID of the pattern to configure. push_protection_setting: type: string description: Push protection setting to set for the pattern. enum: - not-set - disabled - enabled custom_pattern_settings: type: array description: Pattern settings for custom patterns. items: type: object properties: token_type: type: string description: The ID of the pattern to configure. custom_pattern_version: "$ref": "#/components/schemas/secret-scanning-row-version" push_protection_setting: type: string description: Push protection setting to set for the pattern. enum: - disabled - enabled examples: default: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_settings: - token_type: GITHUB_PERSONAL_ACCESS_TOKEN push_protection_setting: enabled custom_pattern_settings: - token_type: cp_2 custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K push_protection_setting: enabled responses: '200': description: Response content: application/json: schema: type: object properties: pattern_config_version: type: string description: The updated pattern configuration version. examples: default: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '422': "$ref": "#/components/responses/validation_failed" "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization description: |- Lists repository security advisories for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/list-org-repository-advisories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/direction" - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated - published default: created - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 30 - name: state description: Filter by the state of the repository advisories. Only advisories of this state will be returned. in: query required: false schema: type: string enum: - triage - draft - published - closed responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-advisory" examples: default: "$ref": "#/components/examples/list-repository-advisories" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories "/orgs/{org}/security-managers": get: summary: List security manager teams description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/list-security-manager-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-simple" examples: default: "$ref": "#/components/examples/team-items" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: orgs subcategory: security-managers deprecationDate: '2024-12-01' removalDate: '2026-01-01' deprecated: true "/orgs/{org}/security-managers/teams/{team_slug}": put: summary: Add a security manager team description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/add-security-manager-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: orgs subcategory: security-managers deprecationDate: '2024-12-01' removalDate: '2026-01-01' deprecated: true delete: summary: Remove a security manager team description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/remove-security-manager-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: orgs subcategory: security-managers deprecationDate: '2024-12-01' removalDate: '2026-01-01' deprecated: true "/orgs/{org}/settings/billing/actions": get: summary: Get GitHub Actions billing for an organization description: |- Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-github-actions-billing-org tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-billing-usage" examples: default: "$ref": "#/components/examples/actions-billing-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: billing subcategory: billing "/orgs/{org}/settings/billing/advanced-security": get: summary: Get GitHub Advanced Security active committers for an organization description: |- Gets the GitHub Advanced Security active committers for an organization per repository. Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository. If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. The total number of repositories with committer information is tracked by the `total_count` field. tags: - billing operationId: billing/get-github-advanced-security-billing-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/advanced-security-product" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Success content: application/json: schema: "$ref": "#/components/schemas/advanced-security-active-committers" examples: default: "$ref": "#/components/examples/advanced-security-active-committers" x-github: githubCloudOnly: true enabledForGitHubApps: true category: billing subcategory: billing "/orgs/{org}/settings/billing/packages": get: summary: Get GitHub Packages billing for an organization description: |- Gets the free and paid storage used for GitHub Packages in gigabytes. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-github-packages-billing-org tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/packages-billing-usage" examples: default: "$ref": "#/components/examples/packages-billing-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: billing subcategory: billing "/orgs/{org}/settings/billing/shared-storage": get: summary: Get shared storage billing for an organization description: |- Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-shared-storage-billing-org tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/combined-billing-usage" examples: default: "$ref": "#/components/examples/combined-billing-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: billing subcategory: billing "/orgs/{org}/settings/immutable-releases": get: summary: Get immutable releases settings for an organization description: |- Gets the immutable releases policy for repositories in an organization. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/get-immutable-releases-settings externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Immutable releases settings response content: application/json: schema: "$ref": "#/components/schemas/immutable-releases-organization-settings" examples: default: value: enforced_repositories: all x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs put: summary: Set immutable releases settings for an organization description: |- Sets the immutable releases policy for repositories in an organization. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/set-immutable-releases-settings externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: enforced_repositories: type: string description: The policy that controls how immutable releases are enforced in the organization. enum: - all - none - selected example: all selected_repository_ids: type: array description: An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. items: type: integer required: - enforced_repositories examples: default: value: enforced_repositories: all x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/settings/immutable-releases/repositories": get: summary: List selected repositories for immutable releases enforcement description: |- List all of the repositories that have been selected for immutable releases enforcement in an organization. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/get-immutable-releases-settings-repositories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/public-repository-paginated" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs put: summary: Set selected repositories for immutable releases enforcement description: |- Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/set-immutable-releases-settings-repositories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: type: array description: An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. items: type: integer required: - selected_repository_ids examples: default: value: selected_repository_ids: - 64780797 responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": put: summary: Enable a selected repository for immutable releases in an organization description: |- Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: orgs/enable-selected-repository-immutable-releases-organization tags: - orgs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs delete: summary: Disable a selected repository for immutable releases in an organization description: |- Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: orgs/disable-selected-repository-immutable-releases-organization tags: - orgs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs "/orgs/{org}/settings/network-configurations": get: summary: List hosted compute network configurations for an organization description: |- Lists all hosted compute network configurations configured in an organization. OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. tags: - hosted-compute operationId: hosted-compute/list-network-configurations-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - network_configurations properties: total_count: type: integer network_configurations: type: array items: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configurations-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: network-configurations post: summary: Create a hosted compute network configuration for an organization description: |- Creates a hosted compute network configuration for an organization. OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. tags: - hosted-compute operationId: hosted-compute/create-network-configuration-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. type: string compute_service: description: The hosted compute service to use for the network configuration. type: string enum: - none - actions network_settings_ids: type: array minItems: 1 maxItems: 1 description: The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. items: type: string required: - name - network_settings_ids examples: default: value: name: my-network-configuration network_settings_ids: - 23456789ABDCEF1 compute_service: actions responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configuration" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: network-configurations "/orgs/{org}/settings/network-configurations/{network_configuration_id}": get: summary: Get a hosted compute network configuration for an organization description: |- Gets a hosted compute network configuration configured in an organization. OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. tags: - hosted-compute operationId: hosted-compute/get-network-configuration-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/network-configuration-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configuration" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: network-configurations patch: summary: Update a hosted compute network configuration for an organization description: |- Updates a hosted compute network configuration for an organization. OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. tags: - hosted-compute operationId: hosted-compute/update-network-configuration-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/network-configuration-id" requestBody: required: true content: application/json: schema: type: object properties: name: description: Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. type: string compute_service: description: The hosted compute service to use for the network configuration. type: string enum: - none - actions network_settings_ids: type: array minItems: 0 maxItems: 1 description: The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. items: type: string examples: default: value: name: my-network-configuration network_settings_ids: - 23456789ABDCEF1 compute_service: actions responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-configuration" examples: default: "$ref": "#/components/examples/network-configuration" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: network-configurations delete: summary: Delete a hosted compute network configuration from an organization description: |- Deletes a hosted compute network configuration from an organization. OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. tags: - hosted-compute operationId: hosted-compute/delete-network-configuration-from-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/network-configuration-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: network-configurations "/orgs/{org}/settings/network-settings/{network_settings_id}": get: summary: Get a hosted compute network settings resource for an organization description: |- Gets a hosted compute network settings resource configured for an organization. OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. tags: - hosted-compute operationId: hosted-compute/get-network-settings-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/network-settings-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/network-settings" examples: default: "$ref": "#/components/examples/network-settings" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: network-configurations "/orgs/{org}/team-sync/groups": get: summary: List IdP groups for an organization description: Lists IdP groups available in an organization. tags: - teams operationId: teams/list-idp-groups-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - name: page description: Page token in: query schema: type: string - name: q description: Filters the results to return only those that begin with the value specified by this parameter. For example, a value of `ab` will return results that begin with "ab". in: query schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/group-mapping" examples: default: "$ref": "#/components/examples/group-mapping-3" headers: Link: example: ; rel="next" schema: type: string x-github: githubCloudOnly: true enabledForGitHubApps: true category: teams subcategory: team-sync "/orgs/{org}/team/{team_slug}/copilot/metrics": get: summary: Get Copilot metrics for a team description: |- Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. > [!NOTE] > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. tags: - copilot operationId: copilot/copilot-metrics-for-team externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. in: query required: false schema: type: string - name: until description: Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. in: query required: false schema: type: string - "$ref": "#/components/parameters/page" - name: per_page description: The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 100 responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/copilot-usage-metrics-day" examples: default: "$ref": "#/components/examples/copilot-usage-metrics-for-day" '500': "$ref": "#/components/responses/internal_error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot subcategory: copilot-metrics "/orgs/{org}/teams": get: summary: List teams description: Lists all teams in an organization that are visible to the authenticated user. tags: - teams operationId: teams/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: default: "$ref": "#/components/examples/team-items" headers: Link: "$ref": "#/components/headers/link" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams post: summary: Create a team description: |- To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-cloud@latest//articles/setting-team-creation-permissions-in-your-organization)." When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/about-teams)". tags: - teams operationId: teams/create externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the team. description: type: string description: The description of the team. maintainers: type: array description: List GitHub usernames for organization members who will become team maintainers. items: type: string repo_names: type: array description: The full name (e.g., "organization-name/repository-name") of repositories to add the team to. items: type: string privacy: type: string description: "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \ \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`" enum: - secret - closed notification_setting: type: string description: "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`" enum: - notifications_enabled - notifications_disabled permission: type: string description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull - push default: pull parent_team_id: type: integer description: The ID of a team to set as the parent team. required: - name examples: default: value: name: Justice League description: A great team permission: push notification_setting: notifications_enabled privacy: closed responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams "/orgs/{org}/teams/{team_slug}": get: summary: Get a team by name description: |- Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Cloud replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/get-by-name externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams patch: summary: Update a team description: |- To edit a team, the authenticated user must either be an organization owner or a team maintainer. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/update-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: The name of the team. description: type: string description: The description of the team. privacy: type: string description: "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \ \n**For a parent or child team:** \n * `closed` - visible to all members of this organization." enum: - secret - closed notification_setting: type: string description: "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications." enum: - notifications_enabled - notifications_disabled permission: type: string description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull - push - admin default: pull parent_team_id: type: integer description: The ID of a team to set as the parent team. nullable: true examples: default: value: name: new team name description: new team description privacy: closed notification_setting: notifications_enabled responses: '200': description: Response when the updated information already exists content: application/json: schema: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full" '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams delete: summary: Delete a team description: |- To delete a team, the authenticated user must be an organization owner or team maintainer. If you are an organization owner, deleting a parent team will delete all of its child teams as well. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. tags: - teams operationId: teams/delete-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams "/orgs/{org}/teams/{team_slug}/discussions": get: summary: List discussions description: |- List all discussions on a team's page. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussions-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: pinned in: query required: false description: Pinned discussions only filter schema: type: string responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussions post: summary: Create a discussion description: |- Creates a new discussion post on a team's page. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: The discussion post's title. body: type: string description: The discussion post's body text. private: type: boolean description: Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. default: false required: - title - body examples: default: value: title: Our first team post body: Hi! This is an area for us to collaborate as a team. responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussions "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": get: summary: Get a discussion description: |- Get a specific discussion on a team's page. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussions patch: summary: Update a discussion description: |- Edits the title and body text of a discussion post. Only the parameters you provide are updated. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The discussion post's title. body: type: string description: The discussion post's body text. examples: default: value: title: Welcome to our first team post responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussions delete: summary: Delete a discussion description: |- Delete a discussion from a team's page. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussions "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": get: summary: List discussion comments description: |- List all comments on a team discussion. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussion-comments-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussion-comments post: summary: Create a discussion comment description: |- Creates a new comment on a team discussion. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-comment-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The discussion comment's body text. required: - body examples: default: value: body: Do you like apples? responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussion-comments "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": get: summary: Get a discussion comment description: |- Get a specific comment on a team discussion. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-comment-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussion-comments patch: summary: Update a discussion comment description: |- Edits the body text of a discussion comment. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-comment-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The discussion comment's body text. required: - body examples: default: value: body: Do you like pineapples? responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussion-comments delete: summary: Delete a discussion comment description: |- Deletes a comment on a team discussion. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-comment-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: discussion-comments "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": get: summary: List reactions for a team discussion comment description: |- List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-comment-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions post: summary: Create reaction for a team discussion comment description: |- Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-comment-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '200': description: Response when the reaction type has already been added to this team discussion comment content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": delete: summary: Delete team discussion comment reaction description: |- > [!NOTE] > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/delete-for-team-discussion-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" - "$ref": "#/components/parameters/reaction-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": get: summary: List reactions for a team discussion description: |- List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions post: summary: Create reaction for a team discussion description: |- Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" x-github: githubCloudOnly: false enabledForGitHubApps: false category: reactions subcategory: reactions "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": delete: summary: Delete team discussion reaction description: |- > [!NOTE] > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/delete-for-team-discussion externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/reaction-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/orgs/{org}/teams/{team_slug}/external-groups": get: summary: List a connection between an external group and a team description: |- Lists a connection between a team and an external group. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/list-linked-external-idp-groups-to-team-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/external-groups" examples: default: "$ref": "#/components/examples/external-groups" x-github: githubCloudOnly: true enabledForGitHubApps: true category: teams subcategory: external-groups patch: summary: Update the connection between an external group and a team description: |- Creates a connection between a team and an external group. Only one external group can be linked to a team. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. tags: - teams operationId: teams/link-external-idp-group-to-team-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" requestBody: required: true content: application/json: schema: type: object properties: group_id: type: integer description: External Group Id example: 1 required: - group_id examples: default: value: group_id: 123 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/external-group" examples: default: "$ref": "#/components/examples/external-group" x-github: githubCloudOnly: true enabledForGitHubApps: false category: teams subcategory: external-groups delete: summary: Remove the connection between an external group and a team description: |- Deletes a connection between a team and an external group. You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - teams operationId: teams/unlink-external-idp-group-from-team-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: false category: teams subcategory: external-groups "/orgs/{org}/teams/{team_slug}/invitations": get: summary: List pending team invitations description: |- The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. tags: - teams operationId: teams/list-pending-invitations-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-invitation" examples: default: "$ref": "#/components/examples/organization-invitation-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: members "/orgs/{org}/teams/{team_slug}/members": get: summary: List team members description: |- Team members will include the members of child teams. To list members in a team, the team must be visible to the authenticated user. tags: - teams operationId: teams/list-members-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - name: role description: Filters members returned by their role in the team. in: query required: false schema: type: string enum: - member - maintainer - all default: all - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: members "/orgs/{org}/teams/{team_slug}/memberships/{username}": get: summary: Get team membership for a user description: |- Team members will include the members of child teams. To get a user's membership with a team, the team must be visible to the authenticated user. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. > [!NOTE] > The response contains the `state` of the membership and the member's `role`. The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). tags: - teams operationId: teams/get-membership-for-user-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-membership" examples: response-if-user-is-a-team-maintainer: "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" '404': description: if user has no team membership x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: members put: summary: Add or update team membership for a user description: |- Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. tags: - teams operationId: teams/add-or-update-membership-for-user-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/username" requestBody: required: false content: application/json: schema: type: object properties: role: type: string description: The role that this user should have in the team. enum: - member - maintainer default: member examples: default: summary: Add or update team membership for an organization member value: role: maintainer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-membership" examples: response-if-users-membership-with-team-is-now-pending: "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" '403': description: Forbidden if team synchronization is set up '422': description: Unprocessable Entity if you attempt to add an organization to a team x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: members delete: summary: Remove team membership for a user description: |- To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. tags: - teams operationId: teams/remove-membership-for-user-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/username" responses: '204': description: Response '403': description: Forbidden if team synchronization is set up x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: members "/orgs/{org}/teams/{team_slug}/projects": get: summary: List team projects description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/list-projects-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-project" examples: default: "$ref": "#/components/examples/team-project-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/orgs/{org}/teams/{team_slug}/projects/{project_id}": get: summary: Check team permissions for a project description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/check-permissions-for-project-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/project-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-project" examples: default: "$ref": "#/components/examples/team-project" '404': description: Not Found if project is not managed by this team x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true put: summary: Add or update team project permissions description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/add-or-update-project-permissions-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/project-id" requestBody: required: false content: application/json: schema: type: object properties: permission: type: string description: 'The permission to grant to the team for this project. Default: the team''s `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' enum: - read - write - admin nullable: true examples: default: summary: Updates the permissions for the team to write for the project value: permission: write responses: '204': description: Response '403': description: Forbidden if the project is not owned by the organization content: application/json: schema: type: object properties: message: type: string documentation_url: type: string examples: response-if-the-project-is-not-owned-by-the-organization: value: message: Must have admin rights to Repository. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true delete: summary: Remove a project from a team description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/remove-project-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/project-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories description: |- Lists a team's repositories visible to the authenticated user. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. tags: - teams operationId: teams/list-repos-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": get: summary: Check team permissions for a repository description: |- Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams operationId: teams/check-permissions-for-repo-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Alternative response with repository permissions content: application/json: schema: "$ref": "#/components/schemas/team-repository" examples: alternative-response-with-repository-permissions: "$ref": "#/components/examples/team-repository-alternative-response-with-repository-permissions" '204': description: Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. '404': description: Not Found if team does not have permission for the repository x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams put: summary: Add or update team repository permissions description: |- 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](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." > [!NOTE] > You 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](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". tags: - teams operationId: teams/add-or-update-repo-permissions-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object properties: permission: type: string description: 'The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team''s `permission` attribute will be used to determine what permission to grant the team on this repository.' examples: default: summary: Adding a team to an organization repository with the write role value: permission: push responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams delete: summary: Remove a repository from a team description: |- If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams operationId: teams/remove-repo-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": get: summary: List IdP groups for a team description: |- List IdP groups connected to a team on GitHub Enterprise Cloud. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. tags: - teams operationId: teams/list-idp-groups-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/group-mapping" examples: default: "$ref": "#/components/examples/group-mapping-3" x-github: githubCloudOnly: true enabledForGitHubApps: false category: teams subcategory: team-sync patch: summary: Create or update IdP group connections description: |- Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. tags: - teams operationId: teams/create-or-update-idp-group-connections-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" requestBody: required: true content: application/json: schema: type: object properties: groups: type: array description: The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. items: type: object properties: group_id: type: string description: ID of the IdP group. group_name: type: string description: Name of the IdP group. group_description: type: string description: Description of the IdP group. required: - group_id - group_name - group_description additionalProperties: false examples: default: value: groups: - group_id: '123' group_name: Octocat admins group_description: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/group-mapping" examples: default: "$ref": "#/components/examples/group-mapping" x-github: githubCloudOnly: true enabledForGitHubApps: false category: teams subcategory: team-sync "/orgs/{org}/teams/{team_slug}/teams": get: summary: List child teams description: |- Lists the child teams of the team specified by `{team_slug}`. > [!NOTE] > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. tags: - teams operationId: teams/list-child-in-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: if child teams exist content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: response-if-child-teams-exist: "$ref": "#/components/examples/team-items-response-if-child-teams-exist" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams "/orgs/{org}/{security_product}/{enablement}": post: summary: Enable or disable a security feature for an organization description: |- > [!WARNING] > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. tags: - orgs operationId: orgs/enable-or-disable-security-product-on-all-org-repos externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/security-product" - "$ref": "#/components/parameters/org-security-product-enablement" requestBody: required: false content: application/json: schema: properties: query_suite: description: |- CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. type: string enum: - default - extended examples: default: value: responses: '204': description: Action started '422': description: The action could not be taken due to an in progress enablement, or a policy is preventing enablement x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: orgs subcategory: orgs deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true "/projects/columns/cards/{card_id}": get: summary: Get a project card description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/get-card externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - "$ref": "#/components/parameters/card-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/project-card" examples: default: "$ref": "#/components/examples/project-card" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: projects-classic subcategory: cards deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true patch: summary: Update an existing project card description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/update-card externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - "$ref": "#/components/parameters/card-id" requestBody: required: false content: application/json: schema: type: object properties: note: description: The project card's note example: Update all gems type: string nullable: true archived: description: Whether or not the card is archived example: false type: boolean examples: default: summary: Change the note on the card value: note: Add payload for delete Project column responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/project-card" examples: default: "$ref": "#/components/examples/project-card" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: true enabledForGitHubApps: true category: projects-classic subcategory: cards deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true delete: summary: Delete a project card description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/delete-card externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - "$ref": "#/components/parameters/card-id" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '403': description: Forbidden content: application/json: schema: type: object properties: message: type: string documentation_url: type: string errors: type: array items: type: string '401': "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: true category: projects-classic subcategory: cards deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/projects/columns/cards/{card_id}/moves": post: summary: Move a project card description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/move-card externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - "$ref": "#/components/parameters/card-id" requestBody: required: true content: application/json: schema: properties: position: description: 'The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.' example: bottom type: string pattern: "^(?:top|bottom|after:\\d+)$" column_id: description: The unique identifier of the column the card should be moved to example: 42 type: integer required: - position type: object examples: default: summary: Move the card to the bottom of the column value: column_id: 42 position: bottom responses: '201': description: Response content: application/json: schema: type: object properties: {} additionalProperties: false examples: default: value: '304': "$ref": "#/components/responses/not_modified" '403': description: Forbidden content: application/json: schema: type: object properties: message: type: string documentation_url: type: string errors: type: array items: type: object properties: code: type: string message: type: string resource: type: string field: type: string '401': "$ref": "#/components/responses/requires_authentication" '503': description: Response content: application/json: schema: type: object properties: code: type: string message: type: string documentation_url: type: string errors: type: array items: type: object properties: code: type: string message: type: string '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: true enabledForGitHubApps: true category: projects-classic subcategory: cards deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/projects/columns/{column_id}": get: summary: Get a project column description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/get-column externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - "$ref": "#/components/parameters/column-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/project-column" examples: default: "$ref": "#/components/examples/project-column" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: columns deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true patch: summary: Update an existing project column description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/update-column externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - "$ref": "#/components/parameters/column-id" requestBody: required: true content: application/json: schema: properties: name: description: Name of the project column example: Remaining tasks type: string required: - name type: object examples: default: summary: Rename the project column value: name: To Do responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/project-column" examples: default: "$ref": "#/components/examples/project-column" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: columns deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true delete: summary: Delete a project column description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/delete-column externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - "$ref": "#/components/parameters/column-id" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: columns deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/projects/columns/{column_id}/cards": get: summary: List project cards description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/list-cards externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - "$ref": "#/components/parameters/column-id" - name: archived_state description: Filters the project cards that are returned by the card's state. in: query required: false schema: type: string enum: - all - archived - not_archived default: not_archived - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/project-card" examples: default: "$ref": "#/components/examples/project-card-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: true enabledForGitHubApps: true category: projects-classic subcategory: cards deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true post: summary: Create a project card description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/create-card externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - "$ref": "#/components/parameters/column-id" requestBody: required: true content: application/json: schema: oneOf: - type: object properties: note: description: The project card's note example: Update all gems type: string nullable: true required: - note - type: object properties: content_id: description: The unique identifier of the content associated with the card example: 42 type: integer content_type: description: The piece of content associated with the card example: PullRequest type: string required: - content_id - content_type examples: default: summary: Create a new card value: note: Add payload for delete Project column responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/project-card" examples: default: "$ref": "#/components/examples/project-card" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': description: Validation failed content: application/json: schema: oneOf: - "$ref": "#/components/schemas/validation-error" - "$ref": "#/components/schemas/validation-error-simple" '503': description: Response content: application/json: schema: type: object properties: code: type: string message: type: string documentation_url: type: string errors: type: array items: type: object properties: code: type: string message: type: string x-github: githubCloudOnly: true enabledForGitHubApps: true category: projects-classic subcategory: cards deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/projects/columns/{column_id}/moves": post: summary: Move a project column description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/move-column externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - "$ref": "#/components/parameters/column-id" requestBody: required: true content: application/json: schema: properties: position: description: 'The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.' example: last type: string pattern: "^(?:first|last|after:\\d+)$" required: - position type: object examples: default: summary: Move the column to the end of the board value: position: last responses: '201': description: Response content: application/json: schema: type: object properties: {} additionalProperties: false examples: default: value: '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed_simple" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: columns deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/list-collaborators externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - "$ref": "#/components/parameters/project-id" - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. in: query required: false schema: type: string enum: - outside - direct - all default: all - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: collaborators deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/projects/{project_id}/collaborators/{username}": put: summary: Add project collaborator description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/add-collaborator externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - "$ref": "#/components/parameters/project-id" - "$ref": "#/components/parameters/username" requestBody: required: false content: application/json: schema: type: object properties: permission: description: The permission to grant the collaborator. enum: - read - write - admin default: write example: write type: string nullable: true examples: default: summary: Applying write permissions for the new collaborator value: permission: write responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: collaborators deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true delete: summary: Remove user as a collaborator description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/remove-collaborator externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - "$ref": "#/components/parameters/project-id" - "$ref": "#/components/parameters/username" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: collaborators deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/projects/{project_id}/collaborators/{username}/permission": get: summary: Get project permission for a user description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - projects-classic operationId: projects-classic/get-permission-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - "$ref": "#/components/parameters/project-id" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/project-collaborator-permission" examples: default: "$ref": "#/components/examples/project-collaborator-permission" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects-classic subcategory: collaborators deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user description: |- > [!NOTE] > Accessing this endpoint does not count against your REST API rate limit. Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search)." * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code)." * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." > [!NOTE] > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - rate-limit operationId: rate-limit/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user parameters: [] responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/rate-limit-overview" examples: default: "$ref": "#/components/examples/rate-limit-overview" headers: X-RateLimit-Limit: "$ref": "#/components/headers/x-rate-limit-limit" X-RateLimit-Remaining: "$ref": "#/components/headers/x-rate-limit-remaining" X-RateLimit-Reset: "$ref": "#/components/headers/x-rate-limit-reset" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: rate-limit subcategory: rate-limit "/repos/{owner}/{repo}": get: summary: Get a repository description: |- The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. > [!NOTE] > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. tags: - repos operationId: repos/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/full-repository" examples: default-response: "$ref": "#/components/examples/full-repository-default-response" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '301': "$ref": "#/components/responses/moved_permanently" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos patch: summary: Update a repository description: "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics) endpoint." tags: - repos operationId: repos/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: The name of the repository. description: type: string description: A short description of the repository. homepage: type: string description: A URL with more information about the repository. private: type: boolean description: "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private." default: false visibility: type: string description: The visibility of the repository. enum: - public - private - internal security_and_analysis: type: object description: |- Specify which security and analysis features to enable or disable for the repository. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. nullable: true properties: advanced_security: type: object description: |- Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." For standalone Code Scanning or Secret Protection products, this parameter cannot be used. properties: status: type: string description: Can be `enabled` or `disabled`. code_security: type: object description: Use the `status` property to enable or disable GitHub Code Security for this repository. properties: status: type: string description: Can be `enabled` or `disabled`. secret_scanning: type: object description: Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." properties: status: type: string description: Can be `enabled` or `disabled`. secret_scanning_push_protection: type: object description: Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." properties: status: type: string description: Can be `enabled` or `disabled`. secret_scanning_ai_detection: type: object description: Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." properties: status: type: string description: Can be `enabled` or `disabled`. secret_scanning_non_provider_patterns: type: object description: Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." properties: status: type: string description: Can be `enabled` or `disabled`. secret_scanning_validity_checks: type: object description: Use the `status` property to enable or disable secret scanning automatic validity checks on supported partner tokens for this repository. properties: status: type: string description: Can be `enabled` or `disabled`. has_issues: type: boolean description: Either `true` to enable issues for this repository or `false` to disable them. default: true has_projects: type: boolean description: Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. default: true has_wiki: type: boolean description: Either `true` to enable the wiki for this repository or `false` to disable it. default: true is_template: type: boolean description: Either `true` to make this repo available as a template repository or `false` to prevent it. default: false default_branch: type: string description: Updates the default branch for this repository. allow_squash_merge: type: boolean description: Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. default: true allow_merge_commit: type: boolean description: Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. default: true allow_rebase_merge: type: boolean description: Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. default: true allow_auto_merge: type: boolean description: Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. default: false delete_branch_on_merge: type: boolean description: Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. default: false allow_update_branch: type: boolean description: Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise. default: false use_squash_pr_title_as_default: type: boolean description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- Required when using `squash_merge_commit_message`. The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- Required when using `merge_commit_message`. The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. archived: type: boolean description: Whether to archive this repository. `false` will unarchive a previously archived repository. default: false allow_forking: type: boolean description: Either `true` to allow private forks, or `false` to prevent private forks. default: false web_commit_signoff_required: type: boolean description: Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits. default: false examples: default: value: name: Hello-World description: This is your first repository homepage: https://github.com private: true has_issues: true has_projects: true has_wiki: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/full-repository" examples: default: "$ref": "#/components/examples/full-repository" '307': "$ref": "#/components/responses/temporary_redirect" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos delete: summary: Delete a repository description: |- Deleting a repository requires admin access. If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a `403 Forbidden` response. OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. tags: - repos operationId: repos/delete externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response '403': description: 'If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:' content: application/json: schema: type: object properties: message: type: string documentation_url: type: string examples: default: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository '307': "$ref": "#/components/responses/temporary_redirect" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/actions/artifacts": get: summary: List artifacts for a repository description: |- Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/list-artifacts-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/artifact-name" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - artifacts properties: total_count: type: integer artifacts: type: array items: "$ref": "#/components/schemas/artifact" examples: default: "$ref": "#/components/examples/artifact-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": get: summary: Get an artifact description: |- Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-artifact externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/artifact-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/artifact" examples: default: "$ref": "#/components/examples/artifact" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts delete: summary: Delete an artifact description: |- Deletes an artifact for a workflow run. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-artifact externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/artifact-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": get: summary: Download an artifact description: |- Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-artifact externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/artifact-id" - name: archive_format in: path required: true schema: type: string responses: '302': description: Response headers: Location: "$ref": "#/components/headers/location" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts "/repos/{owner}/{repo}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for a repository description: |- Gets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-cache-usage-by-repository" examples: default: "$ref": "#/components/examples/actions-cache-usage" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache "/repos/{owner}/{repo}/actions/caches": get: summary: List GitHub Actions caches for a repository description: |- Lists the GitHub Actions caches for a repository. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/actions-cache-git-ref-full" - "$ref": "#/components/parameters/actions-cache-key" - "$ref": "#/components/parameters/actions-cache-list-sort" - "$ref": "#/components/parameters/direction" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-cache-list" examples: default: "$ref": "#/components/examples/actions-cache-list" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: actions subcategory: cache delete: summary: Delete GitHub Actions caches for a repository (using a cache key) description: |- 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. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-actions-cache-by-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/actions-cache-key-required" - "$ref": "#/components/parameters/actions-cache-git-ref-full" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-cache-list" examples: default: "$ref": "#/components/examples/actions-cache-list" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache "/repos/{owner}/{repo}/actions/caches/{cache_id}": delete: summary: Delete a GitHub Actions cache for a repository (using a cache ID) description: |- Deletes a GitHub Actions cache for a repository, using a cache ID. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-actions-cache-by-id externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/cache-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: cache "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run description: |- Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-job-for-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/job-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/job" examples: default: "$ref": "#/components/examples/job" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": get: summary: Download job logs for a workflow run description: |- Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-job-logs-for-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/job-id" responses: '302': description: Response headers: Location: example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": post: summary: Re-run a job from a workflow run description: |- Re-run a job and its dependent jobs in a workflow run. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-job-for-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/job-id" requestBody: required: false content: application/json: schema: type: object nullable: true properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/oidc/customization/sub": get: summary: Get the customization template for an OIDC subject claim for a repository description: |- Gets the customization template for an OpenID Connect (OIDC) subject claim. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-custom-oidc-sub-claim-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Status response content: application/json: schema: "$ref": "#/components/schemas/oidc-custom-sub-repo" examples: default: "$ref": "#/components/examples/oidc-custom-sub-repo" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true previews: [] category: actions subcategory: oidc put: summary: Set the customization template for an OIDC subject claim for a repository description: |- Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-custom-oidc-sub-claim-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: title: Actions OIDC subject customization for a repository description: Actions OIDC subject customization for a repository type: object required: - use_default properties: use_default: description: Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. type: boolean include_claim_keys: description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. type: array items: type: string examples: default: value: use_default: false include_claim_keys: - repo - context responses: '201': description: Empty response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '404': "$ref": "#/components/responses/not_found" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: enabledForGitHubApps: true previews: [] category: actions subcategory: oidc "/repos/{owner}/{repo}/actions/organization-secrets": get: summary: List repository organization secrets description: |- Lists all organization secrets shared with a repository without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-organization-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/actions-secret" examples: default: "$ref": "#/components/examples/actions-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/repos/{owner}/{repo}/actions/organization-variables": get: summary: List repository organization variables description: |- Lists all organization variables shared with a repository. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-organization-variables externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/variables-per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - variables properties: total_count: type: integer variables: type: array items: "$ref": "#/components/schemas/actions-variable" examples: default: "$ref": "#/components/examples/actions-variables-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/repos/{owner}/{repo}/actions/permissions": get: summary: Get GitHub Actions permissions for a repository description: |- Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-github-actions-permissions-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-repository-permissions" examples: default: "$ref": "#/components/examples/actions-repository-permissions" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions put: summary: Set GitHub Actions permissions for a repository description: |- Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-github-actions-permissions-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: enabled: "$ref": "#/components/schemas/actions-enabled" allowed_actions: "$ref": "#/components/schemas/allowed-actions" sha_pinning_required: "$ref": "#/components/schemas/sha-pinning-required" required: - enabled examples: default: value: enabled: true allowed_actions: selected sha_pinning_required: true x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/access": get: summary: Get the level of access for workflows outside of the repository description: |- Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-workflow-access-to-repository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-workflow-access-to-repository" examples: default: "$ref": "#/components/examples/actions-workflow-access-to-repository" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: actions subcategory: permissions put: summary: Set the level of access for workflows outside of the repository description: |- Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-workflow-access-to-repository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-workflow-access-to-repository" examples: default: "$ref": "#/components/examples/actions-workflow-access-to-repository" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: actions subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": get: summary: Get artifact and log retention settings for a repository description: |- Gets artifact and log retention settings for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-artifact-and-log-retention-settings-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" examples: default: value: days: 90 maximum_allowed_days: 365 '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set artifact and log retention settings for a repository description: |- Sets artifact and log retention settings for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-artifact-and-log-retention-settings-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Empty response for successful settings update '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-artifact-and-log-retention" examples: default: summary: Set retention days value: days: 90 x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": get: summary: Get fork PR contributor approval permissions for a repository description: |- Gets the fork PR contributor approval policy for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-fork-pr-contributor-approval-permissions-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: "$ref": "#/components/examples/actions-fork-pr-contributor-approval" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set fork PR contributor approval permissions for a repository description: |- Sets the fork PR contributor approval policy for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-fork-pr-contributor-approval-permissions-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: summary: Set approval policy to first time contributors value: approval_policy: first_time_contributors x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": get: summary: Get private repo fork PR workflow settings for a repository description: |- Gets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-private-repo-fork-pr-workflows-settings-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" examples: default: "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set private repo fork PR workflow settings for a repository description: |- Sets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-private-repo-fork-pr-workflows-settings-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" examples: default: "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" responses: '204': description: Empty response for successful settings update '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: enabledForGitHubApps: true category: actions subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository description: |- Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-allowed-actions-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/selected-actions" examples: default: "$ref": "#/components/examples/selected-actions" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions put: summary: Set allowed actions for a repository description: |- Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings. To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-allowed-actions-repository tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response requestBody: required: false content: application/json: schema: "$ref": "#/components/schemas/selected-actions" examples: selected_actions: "$ref": "#/components/examples/selected-actions" x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/workflow": get: summary: Get default workflow permissions for a repository description: |- Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-get-default-workflow-permissions" examples: default: "$ref": "#/components/examples/actions-default-workflow-permissions" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions put: summary: Set default workflow permissions for a repository description: |- Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Success response '409': description: Conflict response when changing a setting is prevented by the owning organization or enterprise requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/actions-set-default-workflow-permissions" examples: default: "$ref": "#/components/examples/actions-default-workflow-permissions" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions "/repos/{owner}/{repo}/actions/runners": get: summary: List self-hosted runners for a repository description: |- Lists all self-hosted runners configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-self-hosted-runners-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository parameters: - name: name description: The name of a self-hosted runner. in: query schema: type: string - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - runners properties: total_count: type: integer runners: type: array items: "$ref": "#/components/schemas/runner" examples: default: "$ref": "#/components/examples/runner-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runners/downloads": get: summary: List runner applications for a repository description: |- Lists binaries for the runner application that you can download and run. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-runner-applications-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/runner-application" examples: default: "$ref": "#/components/examples/runner-application-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": post: summary: Create configuration for a just-in-time runner for a repository description: |- Generates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the repository. OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. tags: - actions operationId: actions/generate-runner-jitconfig-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object required: - name - runner_group_id - labels properties: name: type: string description: The name of the new runner. runner_group_id: type: integer description: The ID of the runner group to register the runner to. labels: type: array minItems: 1 maxItems: 100 items: type: string description: 'The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.' work_folder: type: string description: The working directory to be used for job execution, relative to the runner install directory. default: _work examples: default: value: name: New runner runner_group_id: 1 labels: - self-hosted - X64 - macOS - no-gpu work_folder: _work responses: '201': "$ref": "#/components/responses/actions_runner_jitconfig" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runners/registration-token": post: summary: Create a registration token for a repository description: |- Returns a token that you can pass to the `config` script. The token expires after one hour. For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: ``` ./config.sh --url https://github.com/octo-org --token TOKEN ``` Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-registration-token-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/authentication-token" examples: default: "$ref": "#/components/examples/authentication-token" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runners/remove-token": post: summary: Create a remove token for a repository description: |- Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. 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 ``` Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-remove-token-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/authentication-token" examples: default: "$ref": "#/components/examples/authentication-token-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runners/{runner_id}": get: summary: Get a self-hosted runner for a repository description: |- Gets a specific self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-self-hosted-runner-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/runner-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/runner" examples: default: "$ref": "#/components/examples/runner" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners delete: summary: Delete a self-hosted runner from a repository description: |- Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-self-hosted-runner-from-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/runner-id" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": get: summary: List labels for a self-hosted runner for a repository description: |- Lists all labels for a self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-labels-for-self-hosted-runner-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/runner-id" responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners post: summary: Add custom labels to a self-hosted runner for a repository description: |- Adds custom labels to a self-hosted runner configured in a repository. Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/runner-id" requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 1 maxItems: 100 description: The names of the custom labels to add to the runner. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners put: summary: Set custom labels for a self-hosted runner for a repository description: |- Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/runner-id" requestBody: required: true content: application/json: schema: type: object required: - labels properties: labels: type: array minItems: 0 maxItems: 100 description: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. items: type: string examples: default: value: labels: - gpu - accelerated responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners delete: summary: Remove all custom labels from a self-hosted runner for a repository description: |- Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/runner-id" responses: '200': "$ref": "#/components/responses/actions_runner_labels_readonly" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": delete: summary: Remove a custom label from a self-hosted runner for a repository description: |- Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/runner-id" - "$ref": "#/components/parameters/runner-label-name" responses: '200': "$ref": "#/components/responses/actions_runner_labels" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: self-hosted-runners "/repos/{owner}/{repo}/actions/runs": get: summary: List workflow runs for a repository description: |- Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. tags: - actions operationId: actions/list-workflow-runs-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/actor" - "$ref": "#/components/parameters/workflow-run-branch" - "$ref": "#/components/parameters/event" - "$ref": "#/components/parameters/workflow-run-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/created" - "$ref": "#/components/parameters/exclude-pull-requests" - "$ref": "#/components/parameters/workflow-run-check-suite-id" - "$ref": "#/components/parameters/workflow-run-head-sha" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - workflow_runs properties: total_count: type: integer workflow_runs: type: array items: "$ref": "#/components/schemas/workflow-run" examples: default: "$ref": "#/components/examples/workflow-run-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}": get: summary: Get a workflow run description: |- Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/get-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" - "$ref": "#/components/parameters/exclude-pull-requests" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/workflow-run" examples: default: "$ref": "#/components/examples/workflow-run" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs delete: summary: Delete a workflow run description: |- Deletes a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/delete-workflow-run tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": get: summary: Get the review history for a workflow run description: |- Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/get-reviews-for-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/environment-approvals" examples: default: "$ref": "#/components/examples/environment-approvals-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": post: summary: Approve a workflow run for a fork pull request description: |- Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/approve-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": get: summary: List workflow run artifacts description: |- Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/list-workflow-run-artifacts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/artifact-name" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - artifacts properties: total_count: type: integer artifacts: type: array items: "$ref": "#/components/schemas/artifact" examples: default: "$ref": "#/components/examples/artifact-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: artifacts "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": get: summary: Get a workflow run attempt description: |- Gets a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/get-workflow-run-attempt externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" - "$ref": "#/components/parameters/attempt-number" - "$ref": "#/components/parameters/exclude-pull-requests" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/workflow-run" examples: default: "$ref": "#/components/examples/workflow-run" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": get: summary: List jobs for a workflow run attempt description: |- Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/list-jobs-for-workflow-run-attempt externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" - "$ref": "#/components/parameters/attempt-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - jobs properties: total_count: type: integer jobs: type: array items: "$ref": "#/components/schemas/job" examples: default: "$ref": "#/components/examples/job-paginated" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": get: summary: Download workflow run attempt logs description: |- Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-workflow-run-attempt-logs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" - "$ref": "#/components/parameters/attempt-number" responses: '302': description: Response headers: Location: example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": post: summary: Cancel a workflow run description: |- Cancels a workflow run using its `id`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/cancel-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": post: summary: Review custom deployment protection rules for a workflow run description: |- Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." > [!NOTE] > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/review-custom-gates-for-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" requestBody: required: true content: application/json: schema: anyOf: - "$ref": "#/components/schemas/review-custom-gates-comment-required" - "$ref": "#/components/schemas/review-custom-gates-state-required" examples: default: value: environment_name: prod-eus state: approved comment: All health checks passed. responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": post: summary: Force cancel a workflow run description: |- Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/force-cancel-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": get: summary: List jobs for a workflow run description: |- Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/list-jobs-for-workflow-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. in: query required: false schema: type: string enum: - latest - all default: latest - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - jobs properties: total_count: type: integer jobs: type: array items: "$ref": "#/components/schemas/job" examples: default: "$ref": "#/components/examples/job-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-jobs "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": get: summary: Download workflow run logs description: |- Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-workflow-run-logs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '302': description: Response headers: Location: example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs delete: summary: Delete workflow run logs description: |- Deletes all logs for a workflow run. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-workflow-run-logs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": get: summary: Get pending deployments for a workflow run description: |- Get all deployment environments for a workflow run that are waiting for protection rules to pass. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-pending-deployments-for-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/pending-deployment" examples: default: "$ref": "#/components/examples/pending-deployment-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs post: summary: Review pending deployments for a workflow run description: |- Approve or reject pending deployments that are waiting on approval by a required reviewer. Required reviewers with read access to the repository contents and deployments can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/review-pending-deployments-for-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" requestBody: required: true content: application/json: schema: type: object properties: environment_ids: type: array description: The list of environment ids to approve or reject example: - 161171787 - 161171795 items: type: integer example: 161171787 state: type: string description: Whether to approve or reject deployment to the specified environments. enum: - approved - rejected example: approved comment: type: string description: A comment to accompany the deployment review example: Ship it! required: - environment_ids - state - comment examples: default: value: environment_ids: - 161171787 state: approved comment: Ship it! responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/deployment" examples: default: "$ref": "#/components/examples/deployment-items" x-github: githubCloudOnly: false enabledForGitHubApps: false category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": post: summary: Re-run a workflow description: |- Re-runs your workflow run using its `id`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-workflow externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" requestBody: required: false content: application/json: schema: type: object nullable: true properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": post: summary: Re-run failed jobs from a workflow run description: |- Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-workflow-failed-jobs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" requestBody: required: false content: application/json: schema: type: object nullable: true properties: enable_debug_logging: type: boolean default: false description: Whether to enable debug logging for the re-run. examples: default: value: responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": get: summary: Get workflow run usage description: "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." tags: - actions operationId: actions/get-workflow-run-usage externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/run-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/workflow-run-usage" examples: default: "$ref": "#/components/examples/workflow-run-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/secrets": get: summary: List repository secrets description: |- Lists all secrets available in a repository without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/actions-secret" examples: default: "$ref": "#/components/examples/actions-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/repos/{owner}/{repo}/actions/secrets/public-key": get: summary: Get a repository public key description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-public-key" examples: default: "$ref": "#/components/examples/actions-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/repos/{owner}/{repo}/actions/secrets/{secret_name}": get: summary: Get a repository secret description: |- Gets a single repository secret without revealing its encrypted value. The authenticated user must have collaborator access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-secret" examples: default: "$ref": "#/components/examples/actions-secret" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets put: summary: Create or update a repository secret description: |- Creates or updates a repository secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-or-update-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: ID of the key you used to encrypt the secret. required: - encrypted_value - key_id examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' responses: '201': description: Response when creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets delete: summary: Delete a repository secret description: |- Deletes a secret in a repository using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/repos/{owner}/{repo}/actions/variables": get: summary: List repository variables description: |- Lists all repository variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-variables externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/variables-per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - variables properties: total_count: type: integer variables: type: array items: "$ref": "#/components/schemas/actions-variable" examples: default: "$ref": "#/components/examples/actions-variables-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables post: summary: Create a repository variable description: |- Creates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-repo-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. required: - name - value examples: default: value: name: USERNAME value: octocat responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/repos/{owner}/{repo}/actions/variables/{name}": get: summary: Get a repository variable description: |- Gets a specific variable in a repository. The authenticated user must have collaborator access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/variable-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-variable" examples: default: "$ref": "#/components/examples/actions-variable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables patch: summary: Update a repository variable description: |- Updates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/update-repo-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/variable-name" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. examples: default: value: name: USERNAME value: octocat responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables delete: summary: Delete a repository variable description: |- Deletes a repository variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-repo-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/variable-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/repos/{owner}/{repo}/actions/workflows": get: summary: List repository workflows description: |- Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/list-repo-workflows externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - workflows properties: total_count: type: integer workflows: type: array items: "$ref": "#/components/schemas/workflow" examples: default: "$ref": "#/components/examples/workflow-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": get: summary: Get a workflow description: |- Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/get-workflow externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/workflow" examples: default: "$ref": "#/components/examples/workflow" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": put: summary: Disable a workflow description: |- Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/disable-workflow externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": post: summary: Create a workflow dispatch event description: |- 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](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) 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](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/create-workflow-dispatch tags: - actions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: '204': description: Response requestBody: required: true content: application/json: schema: type: object properties: ref: type: string description: The git reference for the workflow. The reference can be a branch or tag name. inputs: type: object description: Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. additionalProperties: true maxProperties: 10 required: - ref examples: default: value: ref: topic-branch inputs: name: Mona the Octocat home: San Francisco, CA x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": put: summary: Enable a workflow description: |- Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/enable-workflow externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": get: summary: List workflow runs for a workflow description: |- List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). Anyone with read access to the repository can use this endpoint OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. tags: - actions operationId: actions/list-workflow-runs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" - "$ref": "#/components/parameters/actor" - "$ref": "#/components/parameters/workflow-run-branch" - "$ref": "#/components/parameters/event" - "$ref": "#/components/parameters/workflow-run-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/created" - "$ref": "#/components/parameters/exclude-pull-requests" - "$ref": "#/components/parameters/workflow-run-check-suite-id" - "$ref": "#/components/parameters/workflow-run-head-sha" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - workflow_runs properties: total_count: type: integer workflow_runs: type: array items: "$ref": "#/components/schemas/workflow-run" examples: default: "$ref": "#/components/examples/workflow-run-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": get: summary: Get workflow usage description: "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." tags: - actions operationId: actions/get-workflow-usage externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/workflow-usage" examples: default: "$ref": "#/components/examples/workflow-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: actions subcategory: workflows "/repos/{owner}/{repo}/activity": get: summary: List repository activities description: |- Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. For more information about viewing repository activity, see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." tags: - repos operationId: repos/list-activities externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: ref description: |- The Git reference for the activities you want to list. The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. in: query required: false schema: type: string - name: actor description: The GitHub username to use to filter by the actor who performed the activity. in: query required: false schema: type: string - name: time_period description: |- The time period to filter by. For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). in: query required: false schema: type: string enum: - day - week - month - quarter - year - name: activity_type description: |- The activity type to filter by. For example, you can choose to filter by "force_push", to see all force pushes to the repository. in: query required: false schema: type: string enum: - push - force_push - branch_creation - branch_deletion - pr_merge - merge_queue_merge responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/activity" examples: default: "$ref": "#/components/examples/activity-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/assignees": get: summary: List assignees description: Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest//articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. tags: - issues operationId: issues/list-assignees externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees "/repos/{owner}/{repo}/assignees/{assignee}": get: summary: Check if a user can be assigned description: |- Checks if a user has permission to be assigned to an issue in this repository. If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. Otherwise a `404` status code is returned. tags: - issues operationId: issues/check-user-can-be-assigned externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: assignee in: path required: true schema: type: string responses: '204': description: If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. '404': description: Otherwise a `404` status code is returned. content: application/json: schema: "$ref": "#/components/schemas/basic-error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees "/repos/{owner}/{repo}/attestations": post: summary: Create an attestation description: |- Store an artifact attestation and associate it with a repository. The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/create-attestation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: bundle: type: object properties: mediaType: type: string verificationMaterial: type: object properties: {} additionalProperties: true dsseEnvelope: type: object properties: {} additionalProperties: true description: |- The attestation's Sigstore Bundle. Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. required: - bundle examples: default: summary: Example of a request body value: "$ref": "#/components/examples/attestation" responses: '201': description: response content: application/json: schema: type: object properties: id: type: integer description: The ID of the attestation. examples: default: value: id: 2 '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/attestations/{subject_digest}": get: summary: List attestations description: |- List a collection of artifact attestations with a given subject digest that are associated with a repository. The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/list-attestations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. in: path required: true schema: type: string x-multi-segment: true - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: type: object properties: attestations: type: array items: type: object properties: bundle: type: object properties: mediaType: type: string verificationMaterial: type: object properties: {} additionalProperties: true dsseEnvelope: type: object properties: {} additionalProperties: true description: |- The attestation's Sigstore Bundle. Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer bundle_url: type: string initiator: type: string examples: default: "$ref": "#/components/examples/list-attestations" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/autolinks": get: summary: Get all autolinks of a repository description: |- Gets all autolinks that are configured for a repository. Information about autolinks are only available to repository administrators. tags: - repos operationId: repos/list-autolinks externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/autolink" examples: default: "$ref": "#/components/examples/autolink-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: autolinks post: summary: Create an autolink reference for a repository description: Users with admin access to the repository can create an autolink. tags: - repos operationId: repos/create-autolink externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: key_prefix: type: string description: This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. url_template: type: string description: The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`. is_alphanumeric: type: boolean default: true description: Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters. required: - key_prefix - url_template examples: default: value: key_prefix: TICKET- url_template: https://example.com/TICKET?query= is_alphanumeric: true responses: '201': description: response content: application/json: schema: "$ref": "#/components/schemas/autolink" examples: default: "$ref": "#/components/examples/autolink" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/autolinks/1 schema: type: string '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: autolinks "/repos/{owner}/{repo}/autolinks/{autolink_id}": get: summary: Get an autolink reference of a repository description: |- This returns a single autolink reference by ID that was configured for the given repository. Information about autolinks are only available to repository administrators. tags: - repos operationId: repos/get-autolink externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/autolink-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/autolink" examples: default: "$ref": "#/components/examples/autolink" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: autolinks delete: summary: Delete an autolink reference from a repository description: |- This deletes a single autolink reference by ID that was configured for the given repository. Information about autolinks are only available to repository administrators. tags: - repos operationId: repos/delete-autolink externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/autolink-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: autolinks "/repos/{owner}/{repo}/automated-security-fixes": get: summary: Check if Dependabot security updates are enabled for a repository description: Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/check-automated-security-fixes externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response if Dependabot is enabled content: application/json: schema: "$ref": "#/components/schemas/check-automated-security-fixes" examples: default: value: enabled: true paused: false '404': description: Not Found if Dependabot is not enabled for the repository x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos put: summary: Enable Dependabot security updates description: Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/enable-automated-security-fixes externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos delete: summary: Disable Dependabot security updates description: Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/disable-automated-security-fixes externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/branches": get: summary: List branches description: '' tags: - repos operationId: repos/list-branches externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. in: query required: false schema: type: boolean - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/short-branch" examples: default: "$ref": "#/components/examples/short-branch-with-protection-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branches "/repos/{owner}/{repo}/branches/{branch}": get: summary: Get a branch description: '' tags: - repos operationId: repos/get-branch externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/branch-with-protection" examples: default: "$ref": "#/components/examples/branch-get" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branches "/repos/{owner}/{repo}/branches/{branch}/protection": get: summary: Get branch protection description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-branch-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/branch-protection" examples: default: "$ref": "#/components/examples/branch-protection" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection put: summary: Update branch protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Protecting a branch requires admin or owner permissions to the repository. > [!NOTE] > Passing new arrays of `users` and `teams` replaces their previous values. > [!NOTE] > The list of users, apps, and teams in total is limited to 100 items. tags: - repos operationId: repos/update-branch-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: required_status_checks: type: object description: Require status checks to pass before merging. Set to `null` to disable. nullable: true properties: strict: type: boolean description: Require branches to be up to date before merging. contexts: type: array deprecated: true description: "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control." items: type: string checks: type: array description: The list of status checks to require in order to merge into this branch. items: type: object required: - context properties: context: type: string description: The name of the required check app_id: type: integer description: The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. required: - strict - contexts enforce_admins: type: boolean description: Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. nullable: true required_pull_request_reviews: type: object description: Require at least one approving review on a pull request, before merging. Set to `null` to disable. nullable: true properties: dismissal_restrictions: type: object description: Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. properties: users: type: array description: The list of user `login`s with dismissal access items: type: string teams: type: array description: The list of team `slug`s with dismissal access items: type: string apps: type: array description: The list of app `slug`s with dismissal access items: type: string dismiss_stale_reviews: type: boolean description: Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. require_code_owner_reviews: type: boolean description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) review them. required_approving_review_count: type: integer description: Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. require_last_push_approval: type: boolean description: 'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.' default: false bypass_pull_request_allowances: type: object description: Allow specific users, teams, or apps to bypass pull request requirements. properties: users: type: array description: The list of user `login`s allowed to bypass pull request requirements. items: type: string teams: type: array description: The list of team `slug`s allowed to bypass pull request requirements. items: type: string apps: type: array description: The list of app `slug`s allowed to bypass pull request requirements. items: type: string restrictions: type: object description: Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. nullable: true properties: users: type: array description: The list of user `login`s with push access items: type: string teams: type: array description: The list of team `slug`s with push access items: type: string apps: type: array description: The list of app `slug`s with push access items: type: string required: - users - teams required_linear_history: type: boolean description: 'Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation.' allow_force_pushes: type: boolean description: 'Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation."' nullable: true allow_deletions: type: boolean description: 'Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation.' block_creations: type: boolean description: 'If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.' required_conversation_resolution: type: boolean description: 'Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.' lock_branch: type: boolean description: 'Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.' default: false allow_fork_syncing: type: boolean description: 'Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.' default: false required: - required_status_checks - enforce_admins - required_pull_request_reviews - restrictions examples: default: value: required_status_checks: strict: true contexts: - continuous-integration/travis-ci enforce_admins: true required_pull_request_reviews: dismissal_restrictions: users: - octocat teams: - justice-league dismiss_stale_reviews: true require_code_owner_reviews: true required_approving_review_count: 2 require_last_push_approval: true bypass_pull_request_allowances: users: - octocat teams: - justice-league restrictions: users: - octocat teams: - justice-league apps: - super-ci required_linear_history: true allow_force_pushes: true allow_deletions: true block_creations: true required_conversation_resolution: true lock_branch: true allow_fork_syncing: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/protected-branch" examples: default: "$ref": "#/components/examples/branch-protection-update" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed_simple" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection delete: summary: Delete branch protection description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/delete-branch-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": get: summary: Get admin branch protection description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-admin-branch-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/protected-branch-admin-enforced" examples: default: "$ref": "#/components/examples/protected-branch-admin-enforced-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection post: summary: Set admin branch protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. tags: - repos operationId: repos/set-admin-branch-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/protected-branch-admin-enforced" examples: default: "$ref": "#/components/examples/protected-branch-admin-enforced-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection delete: summary: Delete admin branch protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. tags: - repos operationId: repos/delete-admin-branch-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": get: summary: Get pull request review protection description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-pull-request-review-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/protected-branch-pull-request-review" examples: default: "$ref": "#/components/examples/protected-branch-pull-request-review" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection patch: summary: Update pull request review protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. > [!NOTE] > Passing new arrays of `users` and `teams` replaces their previous values. tags: - repos operationId: repos/update-pull-request-review-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: false content: application/json: schema: type: object properties: dismissal_restrictions: type: object description: Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. properties: users: type: array description: The list of user `login`s with dismissal access items: type: string teams: type: array description: The list of team `slug`s with dismissal access items: type: string apps: type: array description: The list of app `slug`s with dismissal access items: type: string dismiss_stale_reviews: type: boolean description: Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. require_code_owner_reviews: type: boolean description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-cloud@latest//articles/about-code-owners/) have reviewed. required_approving_review_count: type: integer description: Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. require_last_push_approval: type: boolean description: 'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`' default: false bypass_pull_request_allowances: type: object description: Allow specific users, teams, or apps to bypass pull request requirements. properties: users: type: array description: The list of user `login`s allowed to bypass pull request requirements. items: type: string teams: type: array description: The list of team `slug`s allowed to bypass pull request requirements. items: type: string apps: type: array description: The list of app `slug`s allowed to bypass pull request requirements. items: type: string examples: default: value: dismissal_restrictions: users: - octocat teams: - justice-league apps: - octoapp bypass_pull_request_allowances: users: - octocat teams: - justice-league apps: - octoapp dismiss_stale_reviews: true require_code_owner_reviews: true required_approving_review_count: 2 require_last_push_approval: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/protected-branch-pull-request-review" examples: default: "$ref": "#/components/examples/protected-branch-pull-request-review" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection delete: summary: Delete pull request review protection description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/delete-pull-request-review-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": get: summary: Get commit signature protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. > [!NOTE] > You must enable branch protection to require signed commits. tags: - repos operationId: repos/get-commit-signature-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/protected-branch-admin-enforced" examples: default: "$ref": "#/components/examples/protected-branch-admin-enforced" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection post: summary: Create commit signature protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. tags: - repos operationId: repos/create-commit-signature-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/protected-branch-admin-enforced" examples: default: "$ref": "#/components/examples/protected-branch-admin-enforced" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection delete: summary: Delete commit signature protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. tags: - repos operationId: repos/delete-commit-signature-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": get: summary: Get status checks protection description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-status-checks-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/status-check-policy" examples: default: "$ref": "#/components/examples/status-check-policy" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection patch: summary: Update status check protection description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. tags: - repos operationId: repos/update-status-check-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: false content: application/json: schema: type: object properties: strict: type: boolean description: Require branches to be up to date before merging. contexts: type: array deprecated: true description: "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control." items: type: string checks: type: array description: The list of status checks to require in order to merge into this branch. items: type: object required: - context properties: context: type: string description: The name of the required check app_id: type: integer description: The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. examples: default: value: strict: true contexts: - continuous-integration/travis-ci responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/status-check-policy" examples: default: "$ref": "#/components/examples/status-check-policy" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection delete: summary: Remove status check protection description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/remove-status-check-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": get: summary: Get all status check contexts description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/get-all-status-check-contexts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: type: array items: type: string examples: default: value: - continuous-integration/travis-ci '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection post: summary: Add status check contexts description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/add-status-check-contexts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: false content: application/json: schema: oneOf: - type: object properties: contexts: type: array description: The name of the status checks items: type: string required: - contexts example: contexts: - contexts - type: array description: The name of the status checks items: type: string examples: default: summary: Example adding status checks to a branch protection rule value: contexts: - continuous-integration/travis-ci - continuous-integration/jenkins responses: '200': description: Response content: application/json: schema: type: array items: type: string examples: default: value: - continuous-integration/travis-ci - continuous-integration/jenkins '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: contexts category: branches subcategory: branch-protection put: summary: Set status check contexts description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/set-status-check-contexts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: false content: application/json: schema: oneOf: - type: object properties: contexts: type: array description: The name of the status checks items: type: string required: - contexts example: contexts: - contexts - type: array description: The name of the status checks items: type: string examples: default: summary: Example updating status checks for a branch protection rule value: contexts: - continuous-integration/travis-ci responses: '200': description: Response content: application/json: schema: type: array items: type: string examples: default: value: - continuous-integration/travis-ci '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: contexts category: branches subcategory: branch-protection delete: summary: Remove status check contexts description: 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. tags: - repos operationId: repos/remove-status-check-contexts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: content: application/json: schema: oneOf: - type: object properties: contexts: type: array description: The name of the status checks items: type: string required: - contexts example: contexts: - contexts - type: array description: The name of the status checks items: type: string examples: default: summary: Example removing status checks from a branch protection rule value: contexts: - continuous-integration/jenkins responses: '200': description: Response content: application/json: schema: type: array items: type: string examples: default: value: - continuous-integration/travis-ci '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: contexts category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": get: summary: Get access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists who has access to this protected branch. > [!NOTE] > Users, apps, and teams `restrictions` are only available for organization-owned repositories. tags: - repos operationId: repos/get-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/branch-restriction-policy" examples: default: "$ref": "#/components/examples/branch-restriction-policy" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection delete: summary: Delete access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Disables the ability to restrict who can push to this branch. tags: - repos operationId: repos/delete-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": get: summary: Get apps with access to the protected branch description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/get-apps-with-access-to-protected-branch externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/integration" examples: default: "$ref": "#/components/examples/integration-items" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection post: summary: Add app access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/add-app-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: apps: type: array description: 'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.' items: type: string required: - apps example: apps: - my-app examples: default: value: apps: - octoapp responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/integration" examples: default: "$ref": "#/components/examples/integration-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: apps category: branches subcategory: branch-protection put: summary: Set app access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/set-app-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: apps: type: array description: 'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.' items: type: string required: - apps example: apps: - my-app examples: default: value: apps: - octoapp responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/integration" examples: default: "$ref": "#/components/examples/integration-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: apps category: branches subcategory: branch-protection delete: summary: Remove app access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/remove-app-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: apps: type: array description: 'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.' items: type: string required: - apps example: apps: - my-app examples: default: value: apps: - my-app responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/integration" examples: default: "$ref": "#/components/examples/integration-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: apps category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": get: summary: Get teams with access to the protected branch description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams. tags: - repos operationId: repos/get-teams-with-access-to-protected-branch externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: default: "$ref": "#/components/examples/team-items" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection post: summary: Add team access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified teams push access for this branch. You can also give push access to child teams. tags: - repos operationId: repos/add-team-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: false content: application/json: schema: oneOf: - type: object properties: teams: type: array description: The slug values for teams items: type: string required: - teams example: teams: - my-team - type: array description: The slug values for teams items: type: string examples: default: summary: Example adding a team in a branch protection rule value: teams: - justice-league responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: default: "$ref": "#/components/examples/team-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: teams category: branches subcategory: branch-protection put: summary: Set team access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. tags: - repos operationId: repos/set-team-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: false content: application/json: schema: oneOf: - type: object properties: teams: type: array description: The slug values for teams items: type: string required: - teams example: teams: - justice-league - type: array description: The slug values for teams items: type: string examples: default: summary: Example replacing a team in a branch protection rule value: teams: - justice-league responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: default: "$ref": "#/components/examples/team-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: teams category: branches subcategory: branch-protection delete: summary: Remove team access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a team to push to this branch. You can also remove push access for child teams. tags: - repos operationId: repos/remove-team-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: content: application/json: schema: oneOf: - type: object properties: teams: type: array description: The slug values for teams items: type: string required: - teams example: teams: - my-team - type: array description: The slug values for teams items: type: string examples: default: summary: Example removing a team in a branch protection rule value: teams: - octocats responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: default: "$ref": "#/components/examples/team-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: teams category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": get: summary: Get users with access to the protected branch description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the people who have push access to this branch. tags: - repos operationId: repos/get-users-with-access-to-protected-branch externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branch-protection post: summary: Add user access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified people push access for this branch. | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------- | | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | tags: - repos operationId: repos/add-user-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: users: type: array description: The username for users items: type: string required: - users example: users: - mona examples: default: summary: Example adding a user in a branch protection rule value: users: - octocat responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: users category: branches subcategory: branch-protection put: summary: Set user access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------- | | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | tags: - repos operationId: repos/set-user-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: users: type: array description: The username for users items: type: string required: - users example: users: - mona examples: default: summary: Example replacing a user in a branch protection rule value: users: - octocat responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: users category: branches subcategory: branch-protection delete: summary: Remove user access restrictions description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a user to push to this branch. | Type | Description | | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | tags: - repos operationId: repos/remove-user-access-restrictions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: users: type: array description: The username for users items: type: string required: - users example: users: - mona examples: default: summary: Example removing a user in a branch protection rule value: users: - octocat responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true requestBodyParameterName: users category: branches subcategory: branch-protection "/repos/{owner}/{repo}/branches/{branch}/rename": post: summary: Rename a branch description: |- Renames a branch in a repository. > [!NOTE] > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. tags: - repos operationId: repos/rename-branch externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" requestBody: required: true content: application/json: schema: type: object properties: new_name: type: string description: The new name of the branch. required: - new_name examples: default: value: new_name: my_renamed_branch responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/branch-with-protection" examples: default: "$ref": "#/components/examples/branch-with-protection" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branches "/repos/{owner}/{repo}/bypass-requests/push-rules": get: summary: List repository push rule bypass requests description: Lists the requests made by users of a repository to bypass push protection rules tags: - repos operationId: repos/list-repo-push-bypass-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#list-repository-push-rule-bypass-requests x-github: githubCloudOnly: true enabledForGitHubApps: true category: repos subcategory: bypass-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/bypass-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/push-rule-bypass-request" examples: default: "$ref": "#/components/examples/push-rule-bypass-request-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": get: summary: Get a repository push bypass request description: Get information about a request to bypass push protection rules for a repository. tags: - repos operationId: repos/get-repo-push-bypass-request externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#get-a-repository-push-bypass-request x-github: githubCloudOnly: true enabledForGitHubApps: true category: repos subcategory: bypass-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: bypass_request_number in: path required: true schema: type: integer description: The number that identifies the bypass request within the context of the given repository. example: 1 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/push-rule-bypass-request" examples: default: "$ref": "#/components/examples/push-rule-bypass-request-item" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/bypass-requests/secret-scanning": get: summary: List bypass requests for secret scanning for a repository description: |- Lists requests to bypass secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/list-repo-bypass-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/bypass-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of the bypass requests. content: application/json: schema: type: array items: "$ref": "#/components/schemas/secret-scanning-bypass-request" examples: default: "$ref": "#/components/examples/secret-scanning-bypass-request-items" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}": get: summary: Get a bypass request for secret scanning description: |- Gets a specific request to bypass secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/get-bypass-request externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#get-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: bypass_request_number in: path required: true description: The number that identifies the bypass request in a repository. schema: type: integer responses: '200': description: A single bypass request. content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-bypass-request" examples: default: "$ref": "#/components/examples/secret-scanning-bypass-request-item" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" patch: summary: Review a bypass request for secret scanning description: |- Approve or deny a request to bypass secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/review-bypass-request externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#review-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: bypass_request_number in: path required: true description: The number that identifies the bypass request in a repository. schema: type: integer requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: The review action to perform on the bypass request. enum: - approve - reject message: type: string description: A message to include with the review. Has a maximum character length of 2048. required: - status - message examples: default: value: status: reject message: This secret has not been revoked. responses: '200': description: The review of the bypass request. content: application/json: schema: type: object properties: bypass_review_id: type: integer description: ID of the bypass review. examples: default: value: bypass_review_id: 1 '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}": delete: summary: Dismiss a response on a bypass request for secret scanning description: |- Dissmiss a response given to a bypass request for secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/dismiss-bypass-response externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#dismiss-a-response-on-a-bypass-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: delegated-bypass parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: bypass_response_id in: path required: true description: ID of the bypass response. schema: type: integer responses: '204': description: Review was successfully dismissed. '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/check-runs": post: summary: Create a check run description: |- Creates a new check run for a specific commit in a repository. To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. tags: - checks operationId: checks/create externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the check. For example, "code-coverage". head_sha: type: string description: The SHA of the commit. details_url: type: string description: The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. external_id: type: string description: A reference for the run on the integrator's system. status: type: string description: The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. enum: - queued - in_progress - completed - waiting - requested - pending default: queued started_at: type: string format: date-time description: 'The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' conclusion: type: string description: "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this." enum: - action_required - cancelled - failure - neutral - success - skipped - stale - timed_out completed_at: type: string format: date-time description: 'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' output: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. properties: title: type: string description: The title of the check run. summary: type: string maxLength: 65535 description: 'The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.' text: type: string maxLength: 65535 description: 'The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.' annotations: type: array description: Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". maxItems: 50 items: type: object properties: path: type: string description: The path of the file to add an annotation to. For example, `assets/css/main.css`. start_line: type: integer description: The start line of the annotation. Line numbers start at 1. end_line: type: integer description: The end line of the annotation. start_column: type: integer description: The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. end_column: type: integer description: The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. annotation_level: type: string description: The level of the annotation. enum: - notice - warning - failure message: type: string description: A short description of the feedback for these lines of code. The maximum size is 64 KB. title: type: string description: The title that represents the annotation. The maximum size is 255 characters. raw_details: type: string description: Details about this annotation. The maximum size is 64 KB. required: - path - start_line - end_line - annotation_level - message images: type: array description: Adds images to the output displayed in the GitHub pull request UI. items: type: object properties: alt: type: string description: The alternative text for the image. image_url: type: string description: The full URL of the image. caption: type: string description: A short image description. required: - alt - image_url required: - title - summary actions: type: array description: Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object properties: label: type: string maxLength: 20 description: The text to be displayed on a button in the web UI. The maximum size is 20 characters. description: type: string maxLength: 40 description: A short explanation of what this action would do. The maximum size is 40 characters. identifier: type: string maxLength: 20 description: A reference for the action on the integrator's system. The maximum size is 20 characters. required: - label - description - identifier required: - name - head_sha discriminator: propertyName: status oneOf: - properties: status: enum: - completed required: - status - conclusion additionalProperties: true - properties: status: enum: - queued - in_progress additionalProperties: true examples: example-of-in-progress-conclusion: summary: Example of an in_progress conclusion value: name: mighty_readme head_sha: ce587453ced02b1526dfb4cb910479d431683101 status: in_progress external_id: '42' started_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: '' text: '' example-of-completed-conclusion: summary: Example of a completed conclusion value: name: mighty_readme head_sha: ce587453ced02b1526dfb4cb910479d431683101 status: completed started_at: '2017-11-30T19:39:10Z' conclusion: success completed_at: '2017-11-30T19:49:10Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notices. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations: - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'banaas'. raw_details: Do you mean 'bananas' or 'banana'? start_line: 2 end_line: 2 - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'aples' raw_details: Do you mean 'apples' or 'Naples' start_line: 4 end_line: 4 images: - alt: Super bananas image_url: http://example.com/images/42 actions: - label: Fix identifier: fix_errors description: Allow us to fix these errors for you responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/check-run" examples: example-of-completed-conclusion: "$ref": "#/components/examples/check-run-example-of-completed-conclusion" example-of-in-progress-conclusion: "$ref": "#/components/examples/check-run-example-of-in-progress-conclusion" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs "/repos/{owner}/{repo}/check-runs/{check_run_id}": get: summary: Get a check run description: |- Gets a single check run using its `id`. > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/check-run-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/check-run" examples: default: "$ref": "#/components/examples/check-run" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs patch: summary: Update a check run description: |- Updates a check run for a specific commit in a repository. > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/check-run-id" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the check. For example, "code-coverage". details_url: type: string description: The URL of the integrator's site that has the full details of the check. external_id: type: string description: A reference for the run on the integrator's system. started_at: type: string format: date-time description: 'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' status: type: string description: The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. enum: - queued - in_progress - completed - waiting - requested - pending conclusion: type: string description: "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this." enum: - action_required - cancelled - failure - neutral - success - skipped - stale - timed_out completed_at: type: string format: date-time description: 'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' output: type: object description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. properties: title: type: string description: "**Required**." summary: type: string description: Can contain Markdown. maxLength: 65535 text: type: string description: Can contain Markdown. maxLength: 65535 annotations: type: array description: Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". maxItems: 50 items: type: object properties: path: type: string description: The path of the file to add an annotation to. For example, `assets/css/main.css`. start_line: type: integer description: The start line of the annotation. Line numbers start at 1. end_line: type: integer description: The end line of the annotation. start_column: type: integer description: The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. end_column: type: integer description: The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. annotation_level: type: string description: The level of the annotation. enum: - notice - warning - failure message: type: string description: A short description of the feedback for these lines of code. The maximum size is 64 KB. title: type: string description: The title that represents the annotation. The maximum size is 255 characters. raw_details: type: string description: Details about this annotation. The maximum size is 64 KB. required: - path - start_line - end_line - annotation_level - message images: type: array description: Adds images to the output displayed in the GitHub pull request UI. items: type: object properties: alt: type: string description: The alternative text for the image. image_url: type: string description: The full URL of the image. caption: type: string description: A short image description. required: - alt - image_url required: - summary actions: type: array description: Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." maxItems: 3 items: type: object properties: label: type: string maxLength: 20 description: The text to be displayed on a button in the web UI. The maximum size is 20 characters. description: type: string maxLength: 40 description: A short explanation of what this action would do. The maximum size is 40 characters. identifier: type: string maxLength: 20 description: A reference for the action on the integrator's system. The maximum size is 20 characters. required: - label - description - identifier anyOf: - properties: status: enum: - completed required: - conclusion additionalProperties: true - properties: status: enum: - queued - in_progress additionalProperties: true examples: default: value: name: mighty_readme started_at: '2018-05-04T01:14:52Z' status: completed conclusion: success completed_at: '2018-05-04T01:14:52Z' output: title: Mighty Readme report summary: There are 0 failures, 2 warnings, and 1 notices. text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. annotations: - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'banaas'. raw_details: Do you mean 'bananas' or 'banana'? start_line: 2 end_line: 2 - path: README.md annotation_level: warning title: Spell Checker message: Check your spelling for 'aples' raw_details: Do you mean 'apples' or 'Naples' start_line: 4 end_line: 4 images: - alt: Super bananas image_url: http://example.com/images/42 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/check-run" examples: default: "$ref": "#/components/examples/check-run" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": get: summary: List check run annotations description: |- Lists annotations for a check run using the annotation `id`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-annotations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/check-run-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/check-annotation" examples: default: "$ref": "#/components/examples/check-annotation-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": post: summary: Rerequest a check run description: |- Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) to update the check_run if desired. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". tags: - checks operationId: checks/rerequest-run externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/check-run-id" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '403': description: Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App content: application/json: schema: "$ref": "#/components/schemas/basic-error" '422': description: Validation error if the check run is not rerequestable content: application/json: schema: "$ref": "#/components/schemas/basic-error" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs "/repos/{owner}/{repo}/check-suites": post: summary: Create a check suite description: |- Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)". > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/create-suite externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: head_sha: type: string description: The sha of the head commit. required: - head_sha examples: default: value: head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 responses: '200': description: Response when the suite already exists content: application/json: schema: "$ref": "#/components/schemas/check-suite" examples: default: "$ref": "#/components/examples/check-suite" '201': description: Response when the suite was created content: application/json: schema: "$ref": "#/components/schemas/check-suite" examples: default: "$ref": "#/components/examples/check-suite" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: suites "/repos/{owner}/{repo}/check-suites/preferences": patch: summary: Update repository preferences for check suites description: |- Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. tags: - checks operationId: checks/set-suites-preferences externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: auto_trigger_checks: type: array description: Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. items: type: object properties: app_id: type: integer description: The `id` of the GitHub App. setting: type: boolean description: Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. default: true required: - app_id - setting examples: default: value: auto_trigger_checks: - app_id: 4 setting: false responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/check-suite-preference" examples: default: "$ref": "#/components/examples/check-suite-preference" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: suites "/repos/{owner}/{repo}/check-suites/{check_suite_id}": get: summary: Get a check suite description: |- Gets a single check suite using its `id`. > [!NOTE] > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/get-suite externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/check-suite-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/check-suite" examples: default: "$ref": "#/components/examples/check-suite" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: suites "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": get: summary: List check runs in a check suite description: |- Lists check runs for a check suite using its `id`. > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-for-suite externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/check-suite-id" - "$ref": "#/components/parameters/check-name" - "$ref": "#/components/parameters/status" - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. in: query required: false schema: type: string enum: - latest - all default: latest - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - check_runs properties: total_count: type: integer check_runs: type: array items: "$ref": "#/components/schemas/check-run" examples: default: "$ref": "#/components/examples/check-run-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": post: summary: Rerequest a check suite description: Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. tags: - checks operationId: checks/rerequest-suite externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/check-suite-id" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: suites "/repos/{owner}/{repo}/code-scanning/alerts": get: summary: List code scanning alerts for a repository description: |- Lists code scanning alerts. The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert for the default branch (or for the specified Git reference if you used `ref` in the request). OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/list-alerts-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/tool-name" - "$ref": "#/components/parameters/tool-guid" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/git-ref" - "$ref": "#/components/parameters/pr-alias" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: sort description: The property by which to sort the results. in: query required: false schema: type: string enum: - created - updated default: created - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false schema: "$ref": "#/components/schemas/code-scanning-alert-state-query" - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false schema: "$ref": "#/components/schemas/code-scanning-alert-severity" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-alert-items" examples: default: "$ref": "#/components/examples/code-scanning-alert-items" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": get: summary: Get a code scanning alert description: |- Gets a single code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-alert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-alert" examples: default: "$ref": "#/components/examples/code-scanning-alert" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning patch: summary: Update a code scanning alert description: |- Updates the status of a single code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/update-alert tags: - code-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" requestBody: required: true content: application/json: schema: type: object properties: state: "$ref": "#/components/schemas/code-scanning-alert-set-state" dismissed_reason: "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" create_request: "$ref": "#/components/schemas/code-scanning-alert-create-request" required: - state examples: default: value: state: dismissed dismissed_reason: false positive dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. create_request: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-alert" examples: default: "$ref": "#/components/examples/code-scanning-alert-dismissed" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": get: summary: Get the status of an autofix for a code scanning alert description: |- Gets the status and description of an autofix for a code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-autofix externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-autofix" examples: default: "$ref": "#/components/examples/code-scanning-autofix" '400': "$ref": "#/components/responses/code_scanning_bad_request" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning post: summary: Create an autofix for a code scanning alert description: |- Creates an autofix for a code scanning alert. If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/create-autofix externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/code-scanning-autofix" examples: default: "$ref": "#/components/examples/code-scanning-autofix" '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/code-scanning-autofix" examples: default: "$ref": "#/components/examples/code-scanning-autofix-pending" '400': "$ref": "#/components/responses/code_scanning_bad_request" '403': "$ref": "#/components/responses/code_scanning_autofix_create_forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Unprocessable Entity '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": post: summary: Commit an autofix for a code scanning alert description: |- Commits an autofix for a code scanning alert. If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/commit-autofix externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" requestBody: required: false content: application/json: schema: "$ref": "#/components/schemas/code-scanning-autofix-commits" examples: default: "$ref": "#/components/examples/code-scanning-autofix-commits" responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/code-scanning-autofix-commits-response" examples: default: "$ref": "#/components/examples/code-scanning-autofix-commits-response" '400': "$ref": "#/components/responses/code_scanning_bad_request" '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': "$ref": "#/components/responses/not_found" '422': description: Unprocessable Entity '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": get: summary: List instances of a code scanning alert description: |- Lists all instances of the specified code scanning alert. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/list-alert-instances externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/git-ref" - "$ref": "#/components/parameters/pr-alias" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-alert-instance" examples: default: "$ref": "#/components/examples/code-scanning-alert-instances" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/analyses": get: summary: List code scanning analyses for a repository description: |- Lists the details of all code scanning analyses for a repository, starting with the most recent. The response is paginated and you can use the `page` and `per_page` parameters to list the analyses you're interested in. By default 30 analyses are listed per page. The `rules_count` field in the response give the number of rules that were run in the analysis. For very old analyses this data is not available, and `0` is returned in this field. > [!WARNING] > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/list-recent-analyses tags: - code-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/tool-name" - "$ref": "#/components/parameters/tool-guid" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pr-alias" - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false schema: "$ref": "#/components/schemas/code-scanning-ref" - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-sarif-id" - "$ref": "#/components/parameters/direction" - name: sort description: The property by which to sort the results. in: query required: false schema: type: string enum: - created default: created responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-analysis" examples: default: "$ref": "#/components/examples/code-scanning-analysis-items" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": get: summary: Get a code scanning analysis for a repository description: |- Gets a specified code scanning analysis for a repository. The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, the datetime of the analysis, the name of the code scanning tool, and the number of alerts. The `rules_count` field in the default response give the number of rules that were run in the analysis. For very old analyses this data is not available, and `0` is returned in this field. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/get-analysis tags: - code-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-analysis" examples: response: "$ref": "#/components/examples/code-scanning-analysis-default" application/json+sarif: schema: type: object additionalProperties: true examples: response: "$ref": "#/components/examples/code-scanning-analysis-sarif" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/unprocessable_analysis" '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: code-scanning subcategory: code-scanning delete: summary: Delete a code scanning analysis from a repository description: |- Deletes a specified code scanning analysis from a repository. You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. Conceptually, the process is similar to the undo function in a text editor. When you list the analyses for a repository, one or more will be identified as deletable in the response: ``` "deletable": true ``` An analysis is deletable when it's the most recent in a set of analyses. Typically, a repository will have multiple sets of analyses for each enabled code scanning tool, where a set is determined by a unique combination of analysis values: * `ref` * `tool` * `category` If you attempt to delete an analysis that is not the most recent in a set, you'll get a 400 response with the message: ``` Analysis specified is not deletable. ``` The response from a successful `DELETE` operation provides you with two alternative URLs for deleting the next analysis in the set: `next_analysis_url` and `confirm_delete_url`. Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis in a set. This is a useful option if you want to preserve at least one analysis for the specified tool in your repository. Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` in the 200 response is `null`. As an example of the deletion process, let's imagine that you added a workflow that configured a particular code scanning tool to analyze the code in a repository. This tool has added 15 analyses: 10 on the default branch, and another 5 on a topic branch. You therefore have two separate sets of analyses for this tool. You've now decided that you want to remove all of the analyses for the tool. To do this you must make 15 separate deletion requests. To start, you must find an analysis that's identified as deletable. Each set of analyses always has one that's identified as deletable. Having found the deletable analysis for one of the two sets, delete this analysis and then continue deleting the next analysis in the set until they're all deleted. Then repeat the process for the second set. The procedure therefore consists of a nested loop: **Outer loop**: * List the analyses for the repository, filtered by tool. * Parse this list to find a deletable analysis. If found: **Inner loop**: * Delete the identified analysis. * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/delete-analysis tags: - code-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. required: true schema: type: integer - name: confirm_delete in: query description: 'Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you''ll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`' required: false schema: type: string nullable: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-analysis-deletion" examples: default-response: "$ref": "#/components/examples/code-scanning-analysis-deletion" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/codeql/databases": get: summary: List CodeQL databases for a repository description: |- Lists the CodeQL databases that are available in a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/list-codeql-databases externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-codeql-database" examples: default: "$ref": "#/components/examples/code-scanning-codeql-databases" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": get: summary: Get a CodeQL database for a repository description: |- Gets a CodeQL database for a language in a repository. By default this endpoint returns JSON metadata about the CodeQL database. To download the CodeQL database binary content, set the `Accept` header of the request to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-codeql-database externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: language in: path description: The language of the CodeQL database. schema: type: string required: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-codeql-database" examples: default: "$ref": "#/components/examples/code-scanning-codeql-database" '302': "$ref": "#/components/responses/found" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: code-scanning subcategory: code-scanning delete: summary: Delete a CodeQL database description: |- Deletes a CodeQL database for a language in a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/delete-codeql-database externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: language in: path description: The language of the CodeQL database. schema: type: string required: true responses: '204': description: Response '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": post: summary: Create a CodeQL variant analysis description: |- Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). Use the `owner` and `repo` parameters in the URL to specify the controller repository that will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - code-scanning operationId: code-scanning/create-variant-analysis externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object additionalProperties: false properties: language: "$ref": "#/components/schemas/code-scanning-variant-analysis-language" query_pack: description: A Base64-encoded tarball containing a CodeQL query and all its dependencies type: string repositories: type: array description: List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. items: type: string repository_lists: description: List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. type: array maxItems: 1 items: type: string repository_owners: description: List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. type: array maxItems: 1 items: type: string required: - language - query_pack oneOf: - required: - repositories - required: - repository_lists - required: - repository_owners examples: repositories_parameter: summary: Using the "repositories" field. "query_pack" is abridged for brevity. value: language: csharp query_pack: aGVsbG8= repositories: - octocat/Hello-World - octocat/example repository_owners: summary: Using the "repository_owners" field. "query_pack" is abridged. value: language: csharp query_pack: aGVsbG8= repository_owners: - octocat repository_lists: summary: Using the "repository_lists" field. "query_pack" is abridged. value: language: csharp query_pack: aGVsbG8= repository_lists: - top-100-csharp responses: '201': description: Variant analysis submitted for processing content: application/json: schema: "$ref": "#/components/schemas/code-scanning-variant-analysis" examples: repositories_parameter: summary: Response for a successful variant analysis submission value: "$ref": "#/components/examples/code-scanning-variant-analysis" repository_owners: summary: Response for a successful variant analysis submission value: "$ref": "#/components/examples/code-scanning-variant-analysis" repository_lists: summary: Response for a successful variant analysis submission value: "$ref": "#/components/examples/code-scanning-variant-analysis" '404': "$ref": "#/components/responses/not_found" '422': description: Unable to process variant analysis submission content: application/json: schema: "$ref": "#/components/schemas/basic-error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": get: summary: Get the summary of a CodeQL variant analysis description: |- Gets the summary of a CodeQL variant analysis. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-variant-analysis externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. schema: type: integer required: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-variant-analysis" examples: default: "$ref": "#/components/examples/code-scanning-variant-analysis" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": get: summary: Get the analysis status of a repository in a CodeQL variant analysis description: |- Gets the analysis status of a repository in a CodeQL variant analysis. OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-variant-analysis-repo-task externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - "$ref": "#/components/parameters/owner" - name: repo in: path description: The name of the controller repository. schema: type: string required: true - name: codeql_variant_analysis_id in: path description: The ID of the variant analysis. schema: type: integer required: true - name: repo_owner in: path description: The account owner of the variant analysis repository. The name is not case sensitive. schema: type: string required: true - name: repo_name in: path description: The name of the variant analysis repository. schema: type: string required: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-variant-analysis-repo-task" examples: default: "$ref": "#/components/examples/code-scanning-variant-analysis-repo-task" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/default-setup": get: summary: Get a code scanning default setup configuration description: |- Gets a code scanning default setup configuration. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/get-default-setup externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-default-setup" examples: default: "$ref": "#/components/examples/code-scanning-default-setup" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning patch: summary: Update a code scanning default setup configuration description: |- Updates a code scanning default setup configuration. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: - code-scanning operationId: code-scanning/update-default-setup externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/code-scanning-default-setup-update" examples: default: "$ref": "#/components/examples/code-scanning-default-setup-update" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-default-setup-update-response" examples: default: "$ref": "#/components/examples/code-scanning-default-setup-update-response" '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/code_scanning_conflict" '422': "$ref": "#/components/responses/code_scanning_invalid_state" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/sarifs": post: summary: Upload an analysis as SARIF data description: "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** \ |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t \ | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it." operationId: code-scanning/upload-sarif tags: - code-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: commit_sha: "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" ref: "$ref": "#/components/schemas/code-scanning-ref-full" sarif: "$ref": "#/components/schemas/code-scanning-analysis-sarif-file" checkout_uri: description: |- The base directory used in the analysis, as it appears in the SARIF file. This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. example: file:///github/workspace/ type: string format: uri started_at: description: 'The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time type: string tool_name: description: The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. type: string validate: description: |- Whether the SARIF file will be validated according to the code scanning specifications. This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. type: boolean additionalProperties: false required: - commit_sha - ref - sarif examples: default: value: commit_sha: 4b6472266afd7b471e86085a6659e8c7f2b119da ref: refs/heads/master sarif: H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-sarifs-receipt" examples: default: "$ref": "#/components/examples/code-scanning-sarif-upload" '400': description: Bad Request if the sarif field is invalid '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': "$ref": "#/components/responses/not_found" '413': description: Payload Too Large if the sarif field is too large '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": get: summary: Get information about a SARIF upload description: |- Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. operationId: code-scanning/get-sarif tags: - code-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: sarif_id description: The SARIF ID obtained after uploading. in: path schema: type: string required: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-scanning-sarifs-status" examples: default: "$ref": "#/components/examples/code-scanning-sarif-upload-status" '403': "$ref": "#/components/responses/code_scanning_forbidden_read" '404': description: Not Found if the sarif id does not match any upload '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: code-scanning subcategory: code-scanning "/repos/{owner}/{repo}/code-security-configuration": get: summary: Get the code security configuration associated with a repository description: |- Get the code security configuration that manages a repository's code security settings. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - code-security operationId: code-security/get-configuration-for-repository externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/code-security-configuration-for-repository" examples: default: "$ref": "#/components/examples/code-security-configuration-for-repository" '204': "$ref": "#/components/responses/no_content" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: code-security subcategory: configurations "/repos/{owner}/{repo}/codeowners/errors": get: summary: List CODEOWNERS errors description: |- List any syntax errors that are detected in the CODEOWNERS file. For more information about the correct CODEOWNERS syntax, see "[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." tags: - repos operationId: repos/codeowners-errors externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch (e.g. `main`)' in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codeowners-errors" examples: default: "$ref": "#/components/examples/codeowners-errors" '404': description: Resource not found x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: repos subcategory: repos "/repos/{owner}/{repo}/codespaces": get: summary: List codespaces in a repository for the authenticated user description: |- Lists the codespaces associated to a specified repository and the authenticated user. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-in-repository-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - codespaces properties: total_count: type: integer codespaces: type: array items: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespaces-list-for-repository" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces post: summary: Create a codespace in a repository description: |- Creates a codespace owned by the authenticated user in the specified repository. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-with-repo-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object nullable: true properties: ref: description: Git ref (typically a branch name) for this codespace type: string location: description: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. type: string geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. type: string enum: - EuropeWest - SoutheastAsia - UsEast - UsWest client_ip: description: IP for location auto-detection when proxying a request type: string machine: description: Machine type to use for this codespace type: string devcontainer_path: description: Path to devcontainer.json config to use for this codespace type: string multi_repo_permissions_opt_out: description: Whether to authorize requested permissions from devcontainer.json type: boolean working_directory: description: Working directory for this codespace type: string idle_timeout_minutes: description: Time in minutes before codespace stops from inactivity type: integer display_name: description: Display name for this codespace type: string retention_period_minutes: description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). type: integer examples: default: value: ref: main machine: standardLinux32gb responses: '201': description: Response when the codespace was successfully created content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/repos/{owner}/{repo}/codespaces/devcontainers": get: summary: List devcontainer configurations in a repository for the authenticated user description: |- Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files specify launchpoint configurations for codespaces created within the repository. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - devcontainers properties: total_count: type: integer devcontainers: type: array items: type: object required: - path properties: path: type: string name: type: string display_name: type: string examples: default: "$ref": "#/components/examples/codespaces-list-devcontainers-for-repository" '500': "$ref": "#/components/responses/internal_error" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: codespaces "/repos/{owner}/{repo}/codespaces/machines": get: summary: List available machine types for a repository description: |- List the machine types available for a given repository based on its configuration. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/repo-machines-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: location description: The location to check for available machines. Assigned by IP if not provided. in: query schema: type: string example: WestUs2 - name: client_ip description: IP for location auto-detection when proxying a request in: query schema: type: string - name: ref description: The branch or commit to check for prebuild availability and devcontainer restrictions. in: query schema: type: string example: main responses: '200': description: Response content: application/json: schema: type: object required: - total_count - machines properties: total_count: type: integer machines: type: array items: "$ref": "#/components/schemas/codespace-machine" examples: default: "$ref": "#/components/examples/codespace-machines-list" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: machines "/repos/{owner}/{repo}/codespaces/new": get: summary: Get default attributes for a codespace description: |- Gets the default attributes for codespaces created by the user with the repository. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/pre-flight-with-repo-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. in: query schema: type: string example: main - name: client_ip description: An alternative IP for default location auto-detection, such as when proxying a request. in: query schema: type: string example: 1.2.3.4 responses: '200': description: Response when a user is able to create codespaces from the repository. content: application/json: schema: type: object properties: billable_owner: "$ref": "#/components/schemas/simple-user" defaults: type: object required: - location - devcontainer_path properties: location: type: string devcontainer_path: type: string nullable: true examples: default: "$ref": "#/components/examples/codespaces-default-attributes-for-a-codespace" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: codespaces "/repos/{owner}/{repo}/codespaces/permissions_check": get: summary: Check if permissions defined by a devcontainer have been accepted by the authenticated user description: |- Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/check-permissions-for-devcontainer externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. in: query required: true schema: type: string example: master - name: devcontainer_path description: Path to the devcontainer.json configuration to use for the permission check. in: query required: true schema: type: string example: ".devcontainer/example/devcontainer.json" responses: '200': description: Response when the permission check is successful content: application/json: schema: "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer" examples: default: "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: codespaces "/repos/{owner}/{repo}/codespaces/secrets": get: summary: List repository secrets description: |- Lists all development environment secrets available in a repository without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-repo-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/repo-codespaces-secret" examples: default: "$ref": "#/components/examples/repo-codespaces-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: repository-secrets "/repos/{owner}/{repo}/codespaces/secrets/public-key": get: summary: Get a repository public key description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespaces-public-key" examples: default: "$ref": "#/components/examples/codespaces-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: repository-secrets "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": get: summary: Get a repository secret description: |- Gets a single repository development environment secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repo-codespaces-secret" examples: default: "$ref": "#/components/examples/repo-codespaces-secret" x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: repository-secrets put: summary: Create or update a repository secret description: |- Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: - codespaces operationId: codespaces/create-or-update-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: ID of the key you used to encrypt the secret. examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' responses: '201': description: Response when creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: repository-secrets delete: summary: Delete a repository secret description: |- Deletes a development environment secret in a repository using the secret name. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: - codespaces operationId: codespaces/delete-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: codespaces subcategory: repository-secrets "/repos/{owner}/{repo}/collaborators": get: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos operationId: repos/list-collaborators externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. in: query required: false schema: type: string enum: - outside - direct - all default: all - name: permission description: Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. in: query required: false schema: type: string enum: - pull - triage - push - maintain - admin - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/collaborator" examples: default: "$ref": "#/components/examples/collaborator-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: collaborators "/repos/{owner}/{repo}/collaborators/{username}": get: summary: Check if a user is a repository collaborator description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. Team members will include the members of child teams. The authenticated user must have push access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos operationId: repos/check-collaborator externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/username" responses: '204': description: Response if user is a collaborator '404': description: Not Found if user is not a collaborator x-github: githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: collaborators put: summary: Add a repository collaborator description: |- Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: ``` Cannot assign {member} permission of {role name} ``` 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](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations). For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. **Updating an existing collaborator's permission level** The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. **Rate limits** You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. tags: - repos operationId: repos/add-collaborator externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/username" requestBody: required: false content: application/json: schema: type: object properties: permission: type: string description: 'The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.' default: push examples: new-invitation-is-created: summary: Add a collaborator with triage permissions value: permission: triage responses: '201': description: Response when a new invitation is created content: application/json: schema: "$ref": "#/components/schemas/repository-invitation" examples: new-invitation-is-created: "$ref": "#/components/examples/repository-invitation-response-when-a-new-invitation-is-created" '204': description: |- Response when: - an existing collaborator is added as a collaborator - an organization member is added as an individual collaborator - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator '422': description: |- Response when: - validation failed, or the endpoint has been spammed - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: schema: "$ref": "#/components/schemas/validation-error" '403': "$ref": "#/components/responses/forbidden" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: collaborators delete: summary: Remove a repository collaborator description: |- Removes a collaborator from a repository. To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. This endpoint also: - Cancels any outstanding invitations sent by the collaborator - Unassigns the user from any issues - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - Unstars the repository - Updates access permissions to packages Removing a user as a collaborator has the following effects on forks: - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - If the user had their own fork of the repository, the fork will be deleted. - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. > [!NOTE] > A user can still have access to the repository through organization permissions like base repository permissions. Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". tags: - repos operationId: repos/remove-collaborator externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/username" responses: '204': description: No Content when collaborator was removed from the repository. '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: collaborators "/repos/{owner}/{repo}/collaborators/{username}/permission": get: summary: Get repository permissions for a user description: |- Checks the repository permission and role of a collaborator. The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. The `role_name` attribute provides the name of the assigned role, including custom roles. The `permission` can also be used to determine which base level of access the collaborator has to the repository. The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/username" responses: '200': description: if user has admin permissions content: application/json: schema: "$ref": "#/components/schemas/repository-collaborator-permission" examples: response-if-user-has-admin-permissions: "$ref": "#/components/examples/repository-collaborator-permission-response-if-user-has-admin-permissions" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: collaborators "/repos/{owner}/{repo}/comments": get: summary: List commit comments for a repository description: |- Lists the commit comments for a specified repository. Comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/list-commit-comments-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/commit-comment" examples: default: "$ref": "#/components/examples/commit-comment-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: comments "/repos/{owner}/{repo}/comments/{comment_id}": get: summary: Get a commit comment description: |- Gets a specified commit comment. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/get-commit-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/commit-comment" examples: default: "$ref": "#/components/examples/commit-comment" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: comments patch: summary: Update a commit comment description: |- Updates the contents of a specified commit comment. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/update-commit-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The contents of the comment required: - body examples: default: value: body: Nice change responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/commit-comment" examples: default: "$ref": "#/components/examples/commit-comment-2" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: comments delete: summary: Delete a commit comment description: '' tags: - repos operationId: repos/delete-commit-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: comments "/repos/{owner}/{repo}/comments/{comment_id}/reactions": get: summary: List reactions for a commit comment description: List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/list-for-commit-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions post: summary: Create reaction for a commit comment description: Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. tags: - reactions operationId: reactions/create-for-commit-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the commit comment. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '200': description: Reaction exists content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '201': description: Reaction created content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": delete: summary: Delete a commit comment reaction description: |- > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). tags: - reactions operationId: reactions/delete-for-commit-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - "$ref": "#/components/parameters/reaction-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/commits": get: summary: List commits description: |- **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - repos operationId: repos/list-commits externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' in: query required: false schema: type: string - name: path description: Only commits containing this file path will be returned. in: query required: false schema: type: string - name: author description: GitHub username or email address to use to filter by commit author. in: query required: false schema: type: string - name: committer description: GitHub username or email address to use to filter by commit committer. in: query required: false schema: type: string - name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.' in: query required: false schema: type: string format: date-time - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.' in: query required: false schema: type: string format: date-time - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/commit" examples: default: "$ref": "#/components/examples/commit-items" headers: Link: "$ref": "#/components/headers/link" '500': "$ref": "#/components/responses/internal_error" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: commits "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": get: summary: List branches for HEAD commit description: |- 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](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. tags: - repos operationId: repos/list-branches-for-head-commit externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-sha" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/branch-short" examples: default: "$ref": "#/components/examples/branch-short-items" '422': "$ref": "#/components/responses/validation_failed" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: commits "/repos/{owner}/{repo}/commits/{commit_sha}/comments": get: summary: List commit comments description: |- Lists the comments for a specified commit. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/list-comments-for-commit externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-sha" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/commit-comment" examples: default: "$ref": "#/components/examples/commit-comment-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: comments post: summary: Create a commit comment description: |- Create a comment for a commit using its `:commit_sha`. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/create-commit-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-sha" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The contents of the comment. path: type: string description: Relative path of the file to comment on. position: type: integer description: Line index in the diff to comment on. line: type: integer description: "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." required: - body examples: default: value: body: Great stuff path: file1.txt position: 4 line: 1 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/commit-comment" examples: default: "$ref": "#/components/examples/commit-comment" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 schema: type: string '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: comments "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": get: summary: List pull requests associated with a commit description: |- Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. tags: - repos operationId: repos/list-pull-requests-associated-with-commit externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-sha" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/pull-request-simple" examples: default: "$ref": "#/components/examples/pull-request-simple-items" headers: Link: "$ref": "#/components/headers/link" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: commits "/repos/{owner}/{repo}/commits/{ref}": get: summary: Get a commit description: |- Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. > [!NOTE] > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - repos operationId: repos/get-commit externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/commit-ref" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/commit" examples: default: "$ref": "#/components/examples/commit" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: commits "/repos/{owner}/{repo}/commits/{ref}/check-runs": get: summary: List check runs for a Git reference description: |- Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-for-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-ref" - "$ref": "#/components/parameters/check-name" - "$ref": "#/components/parameters/status" - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. in: query required: false schema: type: string enum: - latest - all default: latest - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: app_id in: query required: false schema: type: integer responses: '200': description: Response content: application/json: schema: type: object required: - total_count - check_runs properties: total_count: type: integer check_runs: type: array items: "$ref": "#/components/schemas/check-run" examples: default: "$ref": "#/components/examples/check-run-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: runs "/repos/{owner}/{repo}/commits/{ref}/check-suites": get: summary: List check suites for a Git reference description: |- Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. > [!NOTE] > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-suites-for-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-ref" - name: app_id description: Filters check suites by GitHub App `id`. in: query required: false schema: type: integer example: 1 - "$ref": "#/components/parameters/check-name" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - check_suites properties: total_count: type: integer check_suites: type: array items: "$ref": "#/components/schemas/check-suite" examples: default: "$ref": "#/components/examples/check-suite-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: checks subcategory: suites "/repos/{owner}/{repo}/commits/{ref}/status": get: summary: Get the combined status for a specific reference description: |- Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Additionally, a combined `state` is returned. The `state` is one of: * **failure** if any of the contexts report as `error` or `failure` * **pending** if there are no statuses or a context is `pending` * **success** if the latest status for all contexts is `success` tags: - repos operationId: repos/get-combined-status-for-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-ref" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/combined-commit-status" examples: default: "$ref": "#/components/examples/combined-commit-status" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: statuses "/repos/{owner}/{repo}/commits/{ref}/statuses": get: summary: List commit statuses for a reference description: |- Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. tags: - repos operationId: repos/list-commit-statuses-for-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-ref" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/status" examples: default: "$ref": "#/components/examples/status-items" headers: Link: "$ref": "#/components/headers/link" '301': "$ref": "#/components/responses/moved_permanently" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: statuses "/repos/{owner}/{repo}/community/profile": get: summary: Get community profile metrics description: |- Returns all community profile metrics for a repository. The repository cannot be a fork. The returned metrics include an overall health score, the repository description, the presence of documentation, the detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, README, and CONTRIBUTING files. The `health_percentage` score is defined as a percentage of how many of the recommended community health files are present. For more information, see "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." `content_reports_enabled` is only returned for organization-owned repositories. tags: - repos operationId: repos/get-community-profile-metrics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/community-profile" examples: default: "$ref": "#/components/examples/community-profile" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: community "/repos/{owner}/{repo}/compare/{basehead}": get: summary: Compare two commits description: |- Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.diff`**: Returns the diff of the commit. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. **Working with large comparisons** To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - repos operationId: repos/compare-commits externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - name: basehead description: The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`. in: path required: true x-multi-segment: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/commit-comparison" examples: default: "$ref": "#/components/examples/commit-comparison" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: commits "/repos/{owner}/{repo}/contents/{path}": get: summary: Get repository content description: |- Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. **Notes**: - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). - This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - If the requested file's size is: - 1 MB or smaller: All features of this endpoint are supported. - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - Greater than 100 MB: This endpoint is not supported. tags: - repos operationId: repos/get-content externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path description: path parameter in: path required: true schema: type: string x-multi-segment: true - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' in: query required: false schema: type: string responses: '200': description: Response content: application/vnd.github.object: schema: "$ref": "#/components/schemas/content-tree" examples: response-if-content-is-a-file: "$ref": "#/components/examples/content-file-response-if-content-is-a-file" response-if-content-is-a-directory: "$ref": "#/components/examples/content-file-response-if-content-is-a-directory-object" application/json: schema: oneOf: - "$ref": "#/components/schemas/content-directory" - "$ref": "#/components/schemas/content-file" - "$ref": "#/components/schemas/content-symlink" - "$ref": "#/components/schemas/content-submodule" discriminator: propertyName: type mapping: array: "#/components/schemas/content-directory" file: "#/components/schemas/content-file" symlink: "#/components/schemas/content-symlink" submodule: "#/components/schemas/content-submodule" examples: response-if-content-is-a-file: "$ref": "#/components/examples/content-file-response-if-content-is-a-file" response-if-content-is-a-directory: "$ref": "#/components/examples/content-file-response-if-content-is-a-directory" response-if-content-is-a-symlink: "$ref": "#/components/examples/content-file-response-if-content-is-a-symlink" response-if-content-is-a-submodule: "$ref": "#/components/examples/content-file-response-if-content-is-a-submodule" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '302': "$ref": "#/components/responses/found" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: contents put: summary: Create or update file contents description: |- Creates a new file or replaces an existing file in a repository. > [!NOTE] > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. tags: - repos operationId: repos/create-or-update-file-contents externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path description: path parameter in: path required: true schema: type: string x-multi-segment: true requestBody: required: true content: application/json: schema: type: object properties: message: type: string description: The commit message. content: type: string description: The new file content, using Base64 encoding. sha: type: string description: "**Required if you are updating a file**. The blob SHA of the file being replaced." branch: type: string description: 'The branch name. Default: the repository’s default branch.' committer: type: object description: 'The person that committed the file. Default: the authenticated user.' properties: name: type: string description: The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. email: type: string description: The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. date: type: string example: '"2013-01-05T13:13:22+05:00"' required: - name - email author: type: object description: 'The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.' properties: name: type: string description: The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. email: type: string description: The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. date: type: string example: '"2013-01-15T17:13:22+05:00"' required: - name - email required: - message - content examples: example-for-creating-a-file: summary: Example for creating a file value: message: my commit message committer: name: Monalisa Octocat email: octocat@github.com content: bXkgbmV3IGZpbGUgY29udGVudHM= example-for-updating-a-file: summary: Example for updating a file value: message: a new commit message committer: name: Monalisa Octocat email: octocat@github.com content: bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/file-commit" examples: example-for-updating-a-file: "$ref": "#/components/examples/file-commit-example-for-updating-a-file" '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/file-commit" examples: example-for-creating-a-file: "$ref": "#/components/examples/file-commit-example-for-creating-a-file" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '409': description: Conflict content: application/json: schema: oneOf: - "$ref": "#/components/schemas/basic-error" - "$ref": "#/components/schemas/repository-rule-violation-error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: contents delete: summary: Delete a file description: |- Deletes a file in a repository. You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. > [!NOTE] > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. tags: - repos operationId: repos/delete-file externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path description: path parameter in: path required: true schema: type: string x-multi-segment: true requestBody: required: true content: application/json: schema: type: object properties: message: type: string description: The commit message. sha: type: string description: The blob SHA of the file being deleted. branch: type: string description: 'The branch name. Default: the repository’s default branch' committer: type: object description: object containing information about the committer. properties: name: type: string description: The name of the author (or committer) of the commit email: type: string description: The email of the author (or committer) of the commit author: type: object description: object containing information about the author. properties: name: type: string description: The name of the author (or committer) of the commit email: type: string description: The email of the author (or committer) of the commit required: - message - sha examples: default: value: message: my commit message committer: name: Monalisa Octocat email: octocat@github.com sha: 329688480d39049927147c162b9d2deaf885005f responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/file-commit" examples: default: "$ref": "#/components/examples/file-commit" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: contents "/repos/{owner}/{repo}/contributors": get: summary: List repository contributors description: |- Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance. GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. tags: - repos operationId: repos/list-contributors externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query required: false schema: type: string - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: If repository contains content content: application/json: schema: type: array items: "$ref": "#/components/schemas/contributor" examples: response-if-repository-contains-content: "$ref": "#/components/examples/contributor-items-response-if-repository-contains-content" headers: Link: "$ref": "#/components/headers/link" '204': description: Response if repository is empty '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/dependabot/alerts": get: summary: List Dependabot alerts for a repository description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - dependabot operationId: dependabot/list-alerts-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-states" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." deprecated: true in: query schema: type: integer default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/dependabot-alert" examples: default: "$ref": "#/components/examples/dependabot-alerts-for-repository" '304': "$ref": "#/components/responses/not_modified" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": get: summary: Get a Dependabot alert description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - dependabot operationId: dependabot/get-alert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/dependabot-alert-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependabot-alert" examples: default: "$ref": "#/components/examples/dependabot-alert-open" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts patch: summary: Update a Dependabot alert description: |- The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - dependabot operationId: dependabot/update-alert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/dependabot-alert-number" requestBody: required: true content: application/json: schema: type: object properties: state: type: string description: |- The state of the Dependabot alert. A `dismissed_reason` must be provided when setting the state to `dismissed`. enum: - dismissed - open dismissed_reason: type: string description: "**Required when `state` is `dismissed`.** A reason for dismissing the alert." enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk dismissed_comment: type: string description: An optional comment associated with dismissing the alert. maxLength: 280 required: - state additionalProperties: false examples: default: value: state: dismissed dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependabot-alert" examples: default: "$ref": "#/components/examples/dependabot-alert-dismissed" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true previews: [] category: dependabot subcategory: alerts "/repos/{owner}/{repo}/dependabot/secrets": get: summary: List repository secrets description: |- Lists all secrets available in a repository without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-repo-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/dependabot-secret" examples: default: "$ref": "#/components/examples/dependabot-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/repos/{owner}/{repo}/dependabot/secrets/public-key": get: summary: Get a repository public key description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. tags: - dependabot operationId: dependabot/get-repo-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependabot-public-key" examples: default: "$ref": "#/components/examples/dependabot-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": get: summary: Get a repository secret description: |- Gets a single repository secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependabot-secret" examples: default: "$ref": "#/components/examples/dependabot-secret" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets put: summary: Create or update a repository secret description: |- Creates or updates a repository secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/create-or-update-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: ID of the key you used to encrypt the secret. examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' responses: '201': description: Response when creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets delete: summary: Delete a repository secret description: |- Deletes a secret in a repository using the secret name. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/delete-repo-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependabot subcategory: secrets "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": get: summary: Get a diff of the dependencies between commits description: Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. tags: - dependency-graph operationId: dependency-graph/diff-range externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. in: path required: true schema: type: string - "$ref": "#/components/parameters/manifest-path" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependency-graph-diff" examples: default: "$ref": "#/components/examples/diff-range-response" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/dependency_review_forbidden" x-github: githubCloudOnly: false category: dependency-graph subcategory: dependency-review "/repos/{owner}/{repo}/dependency-graph/sbom": get: summary: Export a software bill of materials (SBOM) for a repository. description: Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. tags: - dependency-graph operationId: dependency-graph/export-sbom externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/dependency-graph-spdx-sbom" examples: default: "$ref": "#/components/examples/dependency-graph-export-sbom-response" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false category: dependency-graph subcategory: sboms "/repos/{owner}/{repo}/dependency-graph/snapshots": post: summary: Create a snapshot of dependencies for a repository description: |- Create a new snapshot of a repository's dependencies. The authenticated user must have access to the repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependency-graph operationId: dependency-graph/create-repository-snapshot externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/snapshot" examples: example-of-a-dependency-submission: "$ref": "#/components/examples/dependency-graph-create-snapshot-request" responses: '201': description: Response content: application/json: schema: type: object required: - id - created_at - result - message properties: id: type: integer description: ID of the created snapshot. created_at: type: string description: The time at which the snapshot was created. result: type: string description: Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed. message: type: string description: A message providing further details about the result, such as why the dependencies were not updated. examples: example-of-a-dependency-submission: "$ref": "#/components/examples/dependency-graph-create-snapshot-success" x-github: githubCloudOnly: false enabledForGitHubApps: true category: dependency-graph subcategory: dependency-submission "/repos/{owner}/{repo}/deployments": get: summary: List deployments description: 'Simple filtering of deployments is available via query parameters:' tags: - repos operationId: repos/list-deployments externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: sha description: The SHA recorded at creation time. in: query required: false schema: type: string default: none - name: ref description: The name of the ref. This can be a branch, tag, or SHA. in: query required: false schema: type: string default: none - name: task description: The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). in: query required: false schema: type: string default: none - name: environment description: The name of the environment that was deployed to (e.g., `staging` or `production`). in: query required: false schema: type: string default: none nullable: true - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/deployment" examples: default: "$ref": "#/components/examples/deployment-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: deployments post: summary: Create a deployment description: |- Deployments offer a few configurable parameters with certain defaults. The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them before we merge a pull request. The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter makes it easier to track which environments have requested deployments. The default environment is `production`. The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched. The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. Merged branch response: You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when: * Auto-merge option is enabled in the repository * Topic branch does not include the latest changes on the base branch, which is `master` in the response example * There are no merge conflicts If there are no new commits in the base branch, a new request to create a deployment should give a successful response. Merge conflict response: This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. Failed commit status checks: This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/create-deployment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: ref: type: string description: The ref to deploy. This can be a branch, tag, or SHA. task: type: string description: Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). default: deploy auto_merge: type: boolean description: Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. default: true required_contexts: type: array description: The [status](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. items: type: string payload: oneOf: - type: object additionalProperties: true - type: string description: JSON payload with extra information about the deployment. default: '' environment: type: string description: Name for the target deployment environment (e.g., `production`, `staging`, `qa`). default: production description: type: string description: Short description of the deployment. default: '' nullable: true transient_environment: type: boolean description: 'Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`' default: false production_environment: type: boolean description: 'Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.' required: - ref examples: simple-example: summary: Simple example value: ref: topic-branch payload: '{ "deploy": "migrate" }' description: Deploy request from hubot advanced-example: summary: Advanced example value: ref: topic-branch auto_merge: false payload: '{ "deploy": "migrate" }' description: Deploy request from hubot required_contexts: - ci/janky - security/brakeman responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment" examples: simple-example: "$ref": "#/components/examples/deployment-simple-example" '202': description: Merged branch response content: application/json: schema: type: object properties: message: type: string examples: merged-branch-response: value: message: Auto-merged master into topic-branch on deployment. '409': description: Conflict when there is a merge conflict or the commit's status checks failed '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: deployments "/repos/{owner}/{repo}/deployments/{deployment_id}": get: summary: Get a deployment description: '' tags: - repos operationId: repos/get-deployment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/deployment-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment" examples: default: "$ref": "#/components/examples/deployment" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: deployments delete: summary: Delete a deployment description: |- 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. To set a deployment as inactive, you must: * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * Mark the active deployment as inactive by adding any non-successful deployment status. For more information, see "[Create a deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status)." OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/delete-deployment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/deployment-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: deployments "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": get: summary: List deployment statuses description: 'Users with pull access can view deployment statuses for a deployment:' tags: - repos operationId: repos/list-deployment-statuses externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/deployment-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/deployment-status" examples: default: "$ref": "#/components/examples/deployment-status-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: statuses post: summary: Create a deployment status description: |- Users with `push` access can create deployment statuses for a given deployment. OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-status externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/deployment-id" requestBody: required: true content: application/json: schema: type: object properties: state: type: string description: The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. enum: - error - failure - inactive - in_progress - queued - pending - success target_url: type: string description: |- The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. > [!NOTE] > It's recommended to use the `log_url` parameter, which replaces `target_url`. default: '' log_url: type: string description: 'The full URL of the deployment''s output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""`' default: '' description: type: string description: A short description of the status. The maximum description length is 140 characters. default: '' environment: type: string description: Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. environment_url: type: string description: 'Sets the URL for accessing your environment. Default: `""`' default: '' auto_inactive: type: boolean description: 'Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status''s deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`' required: - state examples: default: value: environment: production state: success log_url: https://example.com/deployment/42/output description: Deployment finished successfully. responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment-status" examples: default: "$ref": "#/components/examples/deployment-status" headers: Location: example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 schema: type: string '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: statuses "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": get: summary: Get a deployment status description: 'Users with pull access can view a deployment status for a deployment:' tags: - repos operationId: repos/get-deployment-status externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/deployment-id" - name: status_id in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment-status" examples: default: "$ref": "#/components/examples/deployment-status" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: statuses "/repos/{owner}/{repo}/dismissal-requests/code-scanning": get: summary: List dismissal requests for code scanning alerts for a repository description: |- Lists dismissal requests for code scanning alerts for a repository. Delegated alert dismissal must be enabled on the repository. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - code-scanning operationId: code-scanning/list-dismissal-requests-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#list-dismissal-requests-for-code-scanning-alerts-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-dismissal-reviewer-name" - "$ref": "#/components/parameters/alert-dismissal-requester-name" - "$ref": "#/components/parameters/alert-dismissal-time-period" - "$ref": "#/components/parameters/alert-dismissal-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of alert dismissal requests. content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-scanning-alert-dismissal-request" examples: default: "$ref": "#/components/examples/code-scanning-alert-dismissal-request-items" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}": get: summary: Get a dismissal request for a code scanning alert for a repository description: |- Gets a dismissal request to dismiss a code scanning alert in a repository. Delegated alert dismissal must be enabled on the repository. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - code-scanning operationId: code-scanning/get-dismissal-request-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: alert_number in: path required: true description: The number that identifies the code scanning alert. schema: type: integer responses: '200': description: A single dismissal request. content: application/json: schema: "$ref": "#/components/schemas/code-scanning-alert-dismissal-request" examples: default: "$ref": "#/components/examples/code-scanning-alert-dismissal-request-item" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" patch: summary: Review a dismissal request for a code scanning alert for a repository description: |- Approve or deny a dismissal request to dismiss a code scanning alert in a repository. Delegated alert dismissal must be enabled on the repository and the user must be a dismissal reviewer to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - code-scanning operationId: code-scanning/review-dismissal-request-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/alert-dismissal-requests#review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: code-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: alert_number in: path required: true description: The number that identifies the code scanning alert. schema: type: integer requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: The review action to perform on the bypass request. enum: - approve - deny message: type: string description: A message to include with the review. Has a maximum character length of 2048. required: - status - message examples: default: value: status: approve message: Used in tests. responses: '204': description: Successful update '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/dismissal-requests/secret-scanning": get: summary: List alert dismissal requests for secret scanning for a repository description: |- Lists requests to dismiss secret scanning alerts in a repository. Delegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager, or have the "Review and manage secret scanning alert dismissal requests" permission to access this endpoint. tags: - secret-scanning operationId: secret-scanning/list-repo-dismissal-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#list-alert-dismissal-requests-for-secret-scanning-for-a-repository x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/bypass-reviewer-name" - "$ref": "#/components/parameters/bypass-requester-name" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/dismissal-request-status" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: A list of the alert dismissal requests. content: application/json: schema: type: array items: "$ref": "#/components/schemas/secret-scanning-dismissal-request" examples: default: "$ref": "#/components/examples/secret-scanning-dismissal-request-items" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}": get: summary: Get an alert dismissal request for secret scanning description: |- Gets a specific request to dismiss a secret scanning alert in a repository. Delegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager, or have the "Review and manage secret scanning alert dismissal requests" permission to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/get-dismissal-request externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#get-an-alert-dismissal-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: alert_number in: path required: true description: The number that identifies the secret scanning alert in a repository. schema: type: integer responses: '200': description: A single dismissal request. content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-dismissal-request" examples: default: "$ref": "#/components/examples/secret-scanning-dismissal-request-item" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" patch: summary: Review an alert dismissal request for secret scanning description: |- Approve or deny a request to dismiss a secret scanning alert in a repository. Delegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager, or have the "Review and manage secret scanning alert dismissal requests" permission to access this endpoint. Personal access tokens (classic) need the `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/review-dismissal-request externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/alert-dismissal-requests#review-an-alert-dismissal-request-for-secret-scanning x-github: githubCloudOnly: true enabledForGitHubApps: true category: secret-scanning subcategory: alert-dismissal-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: alert_number in: path required: true description: The number that identifies the secret scanning alert in a repository. schema: type: integer requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: The review action to perform on the dismissal request. enum: - approve - deny message: type: string description: A message to include with the review. Has a maximum character length of 2048. required: - status - message examples: default: value: status: deny message: This secret has not been revoked. responses: '200': description: The review of the dismissal request. content: application/json: schema: type: object properties: dismissal_review_id: type: integer description: ID of the dismissal review. examples: default: value: dismissal_review_id: 1 '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/dispatches": post: summary: Create a repository dispatch event description: |- You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#repository_dispatch)." The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. This input example shows how you can use the `client_payload` as a test to debug your workflow. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-dispatch-event externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object required: - event_type properties: event_type: type: string description: A custom webhook event name. Must be 100 characters or fewer. minLength: 1 maxLength: 100 client_payload: type: object description: JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. additionalProperties: true maxProperties: 10 examples: default: value: event_type: on-demand-test client_payload: unit: false integration: true responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/environments": get: summary: List environments description: |- Lists the environments for a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-all-environments externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: description: The number of environments in this repository example: 5 type: integer environments: type: array items: "$ref": "#/components/schemas/environment" examples: default: "$ref": "#/components/examples/environments" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: environments "/repos/{owner}/{repo}/environments/{environment_name}": get: summary: Get an environment description: |- > [!NOTE] > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-environment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/environment" examples: default: "$ref": "#/components/examples/environment" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: environments put: summary: Create or update an environment description: |- Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." > [!NOTE] > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." > [!NOTE] > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-or-update-environment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" requestBody: required: false content: application/json: schema: type: object nullable: true properties: wait_timer: "$ref": "#/components/schemas/wait-timer" prevent_self_review: "$ref": "#/components/schemas/prevent-self-review" reviewers: type: array nullable: true description: The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. items: type: object properties: type: "$ref": "#/components/schemas/deployment-reviewer-type" id: type: integer description: The id of the user or team who can review the deployment example: 4532992 deployment_branch_policy: "$ref": "#/components/schemas/deployment-branch-policy-settings" additionalProperties: false examples: default: value: wait_timer: 30 prevent_self_review: false reviewers: - type: User id: 1 - type: Team id: 1 deployment_branch_policy: protected_branches: false custom_branch_policies: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/environment" examples: default: "$ref": "#/components/examples/environment" '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value content: application/json: schema: "$ref": "#/components/schemas/basic-error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: environments delete: summary: Delete an environment description: OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-an-environment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" responses: '204': description: Default response x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: environments "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": get: summary: List deployment branch policies description: |- Lists the deployment branch policies for an environment. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/list-deployment-branch-policies externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object properties: total_count: description: The number of deployment branch policies for the environment. type: integer example: 2 branch_policies: type: array items: "$ref": "#/components/schemas/deployment-branch-policy" required: - total_count - branch_policies examples: default: "$ref": "#/components/examples/deployment-branch-policies-list" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: branch-policies post: summary: Create a deployment branch policy description: |- Creates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-branch-policy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" examples: example-wildcard: summary: Example of a wildcard name pattern value: name: release/* example-single-branch: summary: Example of a single branch name pattern value: name: main type: branch example-single-tag: summary: Example of a single tag name pattern value: name: v1 type: tag responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment-branch-policy" examples: example-wildcard: "$ref": "#/components/examples/deployment-branch-policy-wildcard" example-single-branch: "$ref": "#/components/examples/deployment-branch-policy-single-branch" example-single-tag: "$ref": "#/components/examples/deployment-branch-policy-single-tag" '404': description: Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false '303': description: Response if the same branch name pattern already exists x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: branch-policies "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": get: summary: Get a deployment branch policy description: |- Gets a deployment branch or tag policy for an environment. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-deployment-branch-policy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/branch-policy-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment-branch-policy" examples: default: "$ref": "#/components/examples/deployment-branch-policy-wildcard" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: branch-policies put: summary: Update a deployment branch policy description: |- Updates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/update-deployment-branch-policy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/branch-policy-id" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" examples: default: value: name: release/* responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment-branch-policy" examples: default: "$ref": "#/components/examples/deployment-branch-policy-wildcard" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: branch-policies delete: summary: Delete a deployment branch policy description: |- Deletes a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-deployment-branch-policy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/branch-policy-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: branch-policies "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": get: summary: Get all deployment protection rules for an environment description: |- 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](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-all-deployment-protection-rules externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/owner" responses: '200': description: List of deployment protection rules content: application/json: schema: type: object properties: total_count: description: The number of enabled custom deployment protection rules for this environment type: integer example: 10 custom_deployment_protection_rules: type: array items: "$ref": "#/components/schemas/deployment-protection-rule" example: "$ref": "#/components/examples/deployment-protection-rules" examples: default: value: total_count: 2 custom_deployment_protection_rules: - id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv enabled: true app: id: 1 node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy slug: a-custom-app integration_url: https://api.github.com/apps/a-custom-app - id: 4 node_id: MDE2OkRlcGxveW1lbnRTdHJ41128 enabled: true app: id: 1 node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy slug: another-custom-app integration_url: https://api.github.com/apps/another-custom-app x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: protection-rules post: summary: Create a custom deployment protection rule on an environment description: |- Enable a custom deployment protection rule for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-protection-rule externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/owner" requestBody: content: application/json: schema: type: object properties: integration_id: type: integer description: The ID of the custom app that will be enabled on the environment. examples: default: value: integration_id: 5 required: true responses: '201': description: The enabled custom deployment protection rule content: application/json: schema: "$ref": "#/components/schemas/deployment-protection-rule" examples: default: "$ref": "#/components/examples/deployment-protection-rule" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: protection-rules "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": get: summary: List custom deployment rule integrations available for an environment description: |- Gets all custom deployment protection rule integrations that are available for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)". OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/list-custom-deployment-rule-integrations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: A list of custom deployment rule integrations available for this environment. content: application/json: schema: type: object properties: total_count: description: The total number of custom deployment protection rule integrations available for this environment. type: integer example: 35 available_custom_deployment_protection_rule_integrations: type: array items: "$ref": "#/components/schemas/custom-deployment-rule-app" examples: default: "$ref": "#/components/examples/custom-deployment-protection-rule-apps" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: protection-rules "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": get: summary: Get a custom deployment protection rule description: |- Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-custom-deployment-protection-rule externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/protection-rule-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/deployment-protection-rule" examples: default: "$ref": "#/components/examples/deployment-protection-rule" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: protection-rules delete: summary: Disable a custom protection rule for an environment description: |- Disables a custom deployment protection rule for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/disable-deployment-protection-rule externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/protection-rule-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: deployments subcategory: protection-rules "/repos/{owner}/{repo}/environments/{environment_name}/secrets": get: summary: List environment secrets description: |- Lists all secrets available in an environment without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-environment-secrets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/actions-secret" examples: default: "$ref": "#/components/examples/actions-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": get: summary: Get an environment public key description: |- Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-environment-public-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-public-key" examples: default: "$ref": "#/components/examples/actions-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": get: summary: Get an environment secret description: |- Gets a single environment secret without revealing its encrypted value. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-environment-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-secret" examples: default: "$ref": "#/components/examples/actions-secret" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets put: summary: Create or update an environment secret description: |- Creates or updates an environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-or-update-environment-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: ID of the key you used to encrypt the secret. required: - encrypted_value - key_id examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' responses: '201': description: Response when creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response when updating a secret x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets delete: summary: Delete an environment secret description: |- Deletes a secret in an environment using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-environment-secret externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/secret-name" responses: '204': description: Default response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: secrets "/repos/{owner}/{repo}/environments/{environment_name}/variables": get: summary: List environment variables description: |- Lists all environment variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-environment-variables externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/variables-per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - variables properties: total_count: type: integer variables: type: array items: "$ref": "#/components/schemas/actions-variable" examples: default: "$ref": "#/components/examples/actions-variables-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables post: summary: Create an environment variable description: |- Create an environment variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-environment-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. required: - name - value examples: default: value: name: USERNAME value: octocat responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": get: summary: Get an environment variable description: |- Gets a specific variable in an environment. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-environment-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/environment-name" - "$ref": "#/components/parameters/variable-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-variable" examples: default: "$ref": "#/components/examples/actions-variable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables patch: summary: Update an environment variable description: |- Updates an environment variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/update-environment-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/variable-name" - "$ref": "#/components/parameters/environment-name" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the variable. value: type: string description: The value of the variable. examples: default: value: name: USERNAME value: octocat responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables delete: summary: Delete an environment variable description: |- Deletes an environment variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-environment-variable externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/variable-name" - "$ref": "#/components/parameters/environment-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: variables "/repos/{owner}/{repo}/events": get: summary: List repository events description: |- > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-repo-events externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: 200-response: "$ref": "#/components/examples/repo-events-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/repos/{owner}/{repo}/forks": get: summary: List forks description: '' tags: - repos operationId: repos/list-forks externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: sort description: The sort order. `stargazers` will sort by star count. in: query required: false schema: type: string enum: - newest - oldest - stargazers - watchers default: newest - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items-2" headers: Link: "$ref": "#/components/headers/link" '400': "$ref": "#/components/responses/bad_request" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: forks post: summary: Create a fork description: |- Create a fork for the authenticated user. > [!NOTE] > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). > [!NOTE] > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. tags: - repos operationId: repos/create-fork externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object nullable: true properties: organization: type: string description: Optional parameter to specify the organization name if forking into an organization. name: type: string description: When forking from an existing repository, a new name for the fork. default_branch_only: type: boolean description: When forking from an existing repository, fork with only the default branch. examples: default: value: organization: octocat name: Hello-World default_branch_only: true responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/full-repository" examples: default: "$ref": "#/components/examples/full-repository" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: forks "/repos/{owner}/{repo}/git/blobs": post: summary: Create a blob description: '' tags: - git operationId: git/create-blob externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The new blob's content. encoding: type: string description: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. default: utf-8 required: - content examples: default: value: content: Content of the blob encoding: utf-8 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/short-blob" examples: default: "$ref": "#/components/examples/short-blob" headers: Location: example: https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 schema: type: string '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" '403': "$ref": "#/components/responses/forbidden" '422': description: Validation failed content: application/json: schema: oneOf: - "$ref": "#/components/schemas/validation-error" - "$ref": "#/components/schemas/repository-rule-violation-error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: blobs "/repos/{owner}/{repo}/git/blobs/{file_sha}": get: summary: Get a blob description: |- The `content` in the response will always be Base64 encoded. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw blob data. - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. **Note** This endpoint supports blobs up to 100 megabytes in size. tags: - git operationId: git/get-blob externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: file_sha in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/blob" examples: default: "$ref": "#/components/examples/blob" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: blobs "/repos/{owner}/{repo}/git/commits": post: summary: Create a commit description: |- Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/create-commit externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: message: type: string description: The commit message tree: type: string description: The SHA of the tree object this commit points to parents: type: array description: The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. items: type: string author: type: object description: Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. properties: name: type: string description: The name of the author (or committer) of the commit email: type: string description: The email of the author (or committer) of the commit date: type: string format: date-time description: 'Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' required: - name - email committer: type: object description: Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. properties: name: type: string description: The name of the author (or committer) of the commit email: type: string description: The email of the author (or committer) of the commit date: type: string format: date-time description: 'Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' signature: type: string description: The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. required: - message - tree examples: default: value: message: my commit message author: name: Mona Octocat email: octocat@github.com date: '2008-07-09T16:13:30+12:00' parents: - 7d1b31e74ee336d15cbd21741bc88a537ed063a0 tree: 827efc6d56897b048c772eb4087f854f46256132 signature: | -----BEGIN PGP SIGNATURE----- iQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv 7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI DkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n 2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA OQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k nrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU +NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB jHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ 3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+ UpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr X11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp eSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc= =5Io4 -----END PGP SIGNATURE----- responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-commit" examples: default: "$ref": "#/components/examples/git-commit" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd schema: type: string '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: commits "/repos/{owner}/{repo}/git/commits/{commit_sha}": get: summary: Get a commit object description: |- Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/get-commit externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/commit-sha" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-commit" examples: default: "$ref": "#/components/examples/git-commit-2" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: commits "/repos/{owner}/{repo}/git/matching-refs/{ref}": get: summary: List matching references description: |- Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. > [!NOTE] > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. tags: - git operationId: git/list-matching-refs externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/git-ref-only" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/git-ref" examples: default: "$ref": "#/components/examples/git-ref-items" headers: Link: "$ref": "#/components/headers/link" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: refs "/repos/{owner}/{repo}/git/ref/{ref}": get: summary: Get a reference description: |- Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. > [!NOTE] > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". tags: - git operationId: git/get-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/git-ref-only" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-ref" examples: default: "$ref": "#/components/examples/git-ref" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: refs "/repos/{owner}/{repo}/git/refs": post: summary: Create a reference description: Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. tags: - git operationId: git/create-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: ref: type: string description: 'The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn''t start with ''refs'' and have at least two slashes, it will be rejected.' sha: type: string description: The SHA1 value for this reference. required: - ref - sha examples: default: value: ref: refs/heads/featureA sha: aa218f56b14c9653891f9e74264a383fa43fefbd responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-ref" examples: default: "$ref": "#/components/examples/git-ref" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': "$ref": "#/components/responses/validation_failed" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: refs "/repos/{owner}/{repo}/git/refs/{ref}": patch: summary: Update a reference description: Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. tags: - git operationId: git/update-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/git-ref-only" requestBody: required: true content: application/json: schema: type: object properties: sha: type: string description: The SHA1 value to set this reference to force: type: boolean description: Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. default: false required: - sha examples: default: value: sha: aa218f56b14c9653891f9e74264a383fa43fefbd force: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-ref" examples: default: "$ref": "#/components/examples/git-ref" '422': "$ref": "#/components/responses/validation_failed" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: refs delete: summary: Delete a reference description: Deletes the provided reference. tags: - git operationId: git/delete-ref externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/git-ref-only" responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: refs "/repos/{owner}/{repo}/git/tags": post: summary: Create a tag object description: |- Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/create-tag externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: tag: type: string description: The tag's name. This is typically a version (e.g., "v0.0.1"). message: type: string description: The tag message. object: type: string description: The SHA of the git object this is tagging. type: type: string description: The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. enum: - commit - tree - blob tagger: type: object description: An object with information about the individual creating the tag. properties: name: type: string description: The name of the author of the tag email: type: string description: The email of the author of the tag date: type: string format: date-time description: 'When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' required: - name - email required: - tag - message - object - type examples: default: value: tag: v0.0.1 message: initial version object: c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c type: commit tagger: name: Monalisa Octocat email: octocat@github.com date: '2011-06-17T14:53:35-07:00' responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-tag" examples: default: "$ref": "#/components/examples/git-tag" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac schema: type: string '422': "$ref": "#/components/responses/validation_failed" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: tags "/repos/{owner}/{repo}/git/tags/{tag_sha}": get: summary: Get a tag description: |- **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/get-tag externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag_sha in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-tag" examples: default: "$ref": "#/components/examples/git-tag" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: tags "/repos/{owner}/{repo}/git/trees": post: summary: Create a tree description: |- The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference)." Returns an error if you try to delete a file that does not exist. tags: - git operationId: git/create-tree externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: tree: type: array description: Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. items: type: object properties: path: type: string description: The file referenced in the tree. mode: type: string description: The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. enum: - '100644' - '100755' - '040000' - '160000' - '120000' type: type: string description: Either `blob`, `tree`, or `commit`. enum: - blob - tree - commit sha: type: string description: "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." nullable: true content: type: string description: "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." base_tree: type: string description: |- The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. required: - tree examples: default: value: base_tree: 9fb037999f264ba9a7fc6274d15fa3ae2ab98312 tree: - path: file.rb mode: '100644' type: blob sha: 44b4fc6d56897b048c772eb4087f854f46256132 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-tree" examples: default: "$ref": "#/components/examples/git-tree" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 schema: type: string '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: trees "/repos/{owner}/{repo}/git/trees/{tree_sha}": get: summary: Get a tree description: |- Returns a single tree using the SHA1 value or ref name for that tree. If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. > [!NOTE] > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. tags: - git operationId: git/get-tree externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path required: true schema: type: string x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees.' in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/git-tree" examples: default-response: "$ref": "#/components/examples/git-tree-default-response" response-recursively-retrieving-a-tree: "$ref": "#/components/examples/git-tree-response-recursively-retrieving-a-tree" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: git subcategory: trees "/repos/{owner}/{repo}/hooks": get: summary: List repository webhooks description: Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. tags: - repos operationId: repos/list-webhooks externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/hook" examples: default: "$ref": "#/components/examples/hook-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks post: summary: Create a repository webhook description: |- Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap. tags: - repos operationId: repos/create-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object nullable: true properties: name: type: string description: 'Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.' config: type: object description: Key/value pairs to provide settings for this webhook. properties: url: "$ref": "#/components/schemas/webhook-config-url" content_type: "$ref": "#/components/schemas/webhook-config-content-type" secret: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. default: - push items: type: string active: type: boolean description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. default: true additionalProperties: false examples: default: value: name: web active: true events: - push - pull_request config: url: https://example.com/webhook content_type: json insecure_ssl: '0' responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/hook" examples: default: "$ref": "#/components/examples/hook" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 schema: type: string '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}": get: summary: Get a repository webhook description: Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." tags: - repos operationId: repos/get-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/hook" examples: default: "$ref": "#/components/examples/hook" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks patch: summary: Update a repository webhook description: Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." tags: - repos operationId: repos/update-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" requestBody: required: true content: application/json: schema: type: object properties: config: "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. default: - push items: type: string add_events: type: array description: Determines a list of events to be added to the list of events that the Hook triggers for. items: type: string remove_events: type: array description: Determines a list of events to be removed from the list of events that the Hook triggers for. items: type: string active: type: boolean description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. default: true examples: default: value: active: true add_events: - pull_request responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/hook" examples: default: "$ref": "#/components/examples/hook" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks delete: summary: Delete a repository webhook description: |- Delete a webhook for an organization. The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. tags: - repos operationId: repos/delete-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for a repository description: |- Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. tags: - repos operationId: repos/get-webhook-config-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/webhook-config" examples: default: "$ref": "#/components/examples/webhook-config" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks patch: summary: Update a webhook configuration for a repository description: |- Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. tags: - repos operationId: repos/update-webhook-config-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" requestBody: required: false content: application/json: schema: type: object additionalProperties: false properties: url: "$ref": "#/components/schemas/webhook-config-url" content_type: "$ref": "#/components/schemas/webhook-config-content-type" secret: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" examples: default: summary: Example of updating content type and URL value: content_type: json url: https://example.com/webhook responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/webhook-config" examples: default: "$ref": "#/components/examples/webhook-config" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": get: summary: List deliveries for a repository webhook description: Returns a list of webhook deliveries for a webhook configured in a repository. tags: - repos operationId: repos/list-webhook-deliveries externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/cursor" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/hook-delivery-item" examples: default: "$ref": "#/components/examples/hook-delivery-items" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a delivery for a repository webhook description: Returns a delivery for a webhook configured in a repository. tags: - repos operationId: repos/get-webhook-delivery externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/delivery-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/hook-delivery" examples: default: "$ref": "#/components/examples/hook-delivery" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for a repository webhook description: Redeliver a webhook delivery for a webhook configured in a repository. tags: - repos operationId: repos/redeliver-webhook-delivery externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" - "$ref": "#/components/parameters/delivery-id" responses: '202': "$ref": "#/components/responses/accepted" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/pings": post: summary: Ping a repository webhook description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook. tags: - repos operationId: repos/ping-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/tests": post: summary: Test the push repository webhook description: |- This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. > [!NOTE] > Previously `/repos/:owner/:repo/hooks/:hook_id/test` tags: - repos operationId: repos/test-push-webhook externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/hook-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: webhooks "/repos/{owner}/{repo}/immutable-releases": get: summary: Check if immutable releases are enabled for a repository description: |- Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being enforced by the repository owner. The authenticated user must have admin read access to the repository. tags: - repos operationId: repos/check-immutable-releases externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response if immutable releases are enabled content: application/json: schema: "$ref": "#/components/schemas/check-immutable-releases" examples: default: value: enabled: true enforced_by_owner: false '404': description: Not Found if immutable releases are not enabled for the repository x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos put: summary: Enable immutable releases description: Enables immutable releases for a repository. The authenticated user must have admin access to the repository. tags: - repos operationId: repos/enable-immutable-releases externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': "$ref": "#/components/responses/no_content" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos delete: summary: Disable immutable releases description: Disables immutable releases for a repository. The authenticated user must have admin access to the repository. tags: - repos operationId: repos/disable-immutable-releases externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': "$ref": "#/components/responses/no_content" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/import": get: summary: Get an import status description: |- View the progress of an import. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** This section includes details about the possible values of the `status` field of the Import Progress response. An import that does not have errors will progress through these steps: * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". * `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud. If there are problems, you will see one of these in the `status` field: * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL. * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. **The project_choices field** When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. **Git LFS related fields** This section includes details about Git LFS related fields that may be present in the Import Progress response. * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. tags: - migrations operationId: migrations/get-import-status externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/import" examples: default: "$ref": "#/components/examples/import" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true put: summary: Start an import description: |- Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/start-import externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: vcs_url: type: string description: The URL of the originating repository. vcs: type: string description: The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. enum: - subversion - git - mercurial - tfvc vcs_username: type: string description: If authentication is required, the username to provide to `vcs_url`. vcs_password: type: string description: If authentication is required, the password to provide to `vcs_url`. tfvc_project: type: string description: For a tfvc import, the name of the project that is being imported. required: - vcs_url examples: default: value: vcs: subversion vcs_url: http://svn.mycompany.com/svn/myproject vcs_username: octocat vcs_password: secret responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/import" examples: default: "$ref": "#/components/examples/import-2" headers: Location: example: https://api.github.com/repos/spraints/socm/import schema: type: string '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true patch: summary: Update an import description: |- An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted. Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/update-import externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object properties: vcs_username: type: string description: The username to provide to the originating repository. vcs_password: type: string description: The password to provide to the originating repository. vcs: type: string description: The type of version control system you are migrating from. enum: - subversion - tfvc - git - mercurial example: '"git"' tfvc_project: type: string description: For a tfvc import, the name of the project that is being imported. example: '"project1"' nullable: true examples: example-1: summary: Update authentication for an import value: vcs_username: octocat vcs_password: secret example-2: summary: Updating the project choice value: vcs: tfvc tfvc_project: project1 human_name: project1 (tfs) example-3: summary: Restarting an import responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/import" examples: example-1: "$ref": "#/components/examples/import-example-1" example-2: "$ref": "#/components/examples/import-example-2" example-3: "$ref": "#/components/examples/import-response" '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true delete: summary: Cancel an import description: |- Stop an import for a repository. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/cancel-import externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true "/repos/{owner}/{repo}/import/authors": get: summary: Get commit authors description: |- Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-commit-authors externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/since-user" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/porter-author" examples: default: "$ref": "#/components/examples/porter-author-items" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true "/repos/{owner}/{repo}/import/authors/{author_id}": patch: summary: Map a commit author description: |- Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/map-commit-author externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: author_id in: path required: true schema: type: integer requestBody: required: false content: application/json: schema: type: object properties: email: type: string description: The new Git author email. name: type: string description: The new Git author name. additionalProperties: false examples: default: value: email: hubot@github.com name: Hubot the Robot responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/porter-author" examples: default: "$ref": "#/components/examples/porter-author" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true "/repos/{owner}/{repo}/import/large_files": get: summary: Get large files description: |- List files larger than 100MB found during the import > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-large-files externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/porter-large-file" examples: default: "$ref": "#/components/examples/porter-large-file-items" '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true "/repos/{owner}/{repo}/import/lfs": patch: summary: Update Git LFS preference description: |- You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). > [!WARNING] > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/set-lfs-preference externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: use_lfs: type: string description: Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import. enum: - opt_in - opt_out required: - use_lfs examples: default: value: use_lfs: opt_in responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/import" examples: default: "$ref": "#/components/examples/import" '422': "$ref": "#/components/responses/validation_failed" '503': "$ref": "#/components/responses/porter_maintenance" x-github: githubCloudOnly: false enabledForGitHubApps: true category: migrations subcategory: source-imports deprecationDate: '2023-10-12' removalDate: '2024-04-12' deprecated: true "/repos/{owner}/{repo}/installation": get: summary: Get a repository installation for the authenticated app description: |- Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-repo-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/installation" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps "/repos/{owner}/{repo}/interaction-limits": get: summary: Get interaction restrictions for a repository description: Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. tags: - interactions operationId: interactions/get-restrictions-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: anyOf: - "$ref": "#/components/schemas/interaction-limit-response" - type: object properties: {} additionalProperties: false examples: default: "$ref": "#/components/examples/interaction-limit-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: interactions subcategory: repos put: summary: Set interaction restrictions for a repository description: Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. tags: - interactions operationId: interactions/set-restrictions-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/interaction-limit" examples: default: summary: Example request body value: limit: collaborators_only expiry: one_day responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/interaction-limit-response" examples: default: "$ref": "#/components/examples/interaction-limit-2" '409': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: interactions subcategory: repos delete: summary: Remove interaction restrictions for a repository description: Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. tags: - interactions operationId: interactions/remove-restrictions-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response '409': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: interactions subcategory: repos "/repos/{owner}/{repo}/invitations": get: summary: List repository invitations description: When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. tags: - repos operationId: repos/list-invitations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-invitation" examples: default: "$ref": "#/components/examples/repository-invitation-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: invitations "/repos/{owner}/{repo}/invitations/{invitation_id}": patch: summary: Update a repository invitation description: '' tags: - repos operationId: repos/update-invitation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/invitation-id" requestBody: required: false content: application/json: schema: type: object properties: permissions: type: string description: The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. enum: - read - write - maintain - triage - admin examples: default: summary: Example request body value: permissions: write responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-invitation" examples: default: "$ref": "#/components/examples/repository-invitation" x-github: githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: invitations delete: summary: Delete a repository invitation description: '' tags: - repos operationId: repos/delete-invitation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/invitation-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: collaborators subcategory: invitations "/repos/{owner}/{repo}/issues": get: summary: List repository issues description: |- List issues in a repository. Only open issues will be listed. > [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. in: query required: false schema: type: string - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - name: assignee description: Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. in: query required: false schema: type: string - name: type description: Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. in: query required: false schema: type: string - name: creator description: The user that created the issue. in: query required: false schema: type: string - name: mentioned description: A user that's mentioned in the issue. in: query required: false schema: type: string - "$ref": "#/components/parameters/labels" - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue-items" headers: Link: "$ref": "#/components/headers/link" '301': "$ref": "#/components/responses/moved_permanently" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues post: summary: Create an issue description: |- Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/create externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: title: oneOf: - type: string - type: integer description: The title of the issue. body: type: string description: The contents of the issue. assignee: type: string description: 'Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_' nullable: true milestone: oneOf: - type: string - type: integer description: 'The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._' nullable: true labels: type: array description: 'Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._' items: oneOf: - type: string - type: object properties: id: type: integer name: type: string description: type: string nullable: true color: type: string nullable: true assignees: type: array description: 'Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._' items: type: string type: type: string description: 'The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._' nullable: true example: Epic required: - title examples: default: value: title: Found a bug body: I'm having a problem with this. assignees: - octocat milestone: 1 labels: - bug responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 schema: type: string '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '503': "$ref": "#/components/responses/service_unavailable" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues "/repos/{owner}/{repo}/issues/comments": get: summary: List issue comments for a repository description: |- You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. By default, issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-comments-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/sort" - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue-comment" examples: default: "$ref": "#/components/examples/issue-comment-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments "/repos/{owner}/{repo}/issues/comments/{comment_id}": get: summary: Get an issue comment description: |- You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/get-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue-comment" examples: default: "$ref": "#/components/examples/issue-comment" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments patch: summary: Update an issue comment description: |- You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/update-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The contents of the comment. required: - body examples: default: value: body: Me too responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue-comment" examples: default: "$ref": "#/components/examples/issue-comment" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments delete: summary: Delete an issue comment description: 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. tags: - issues operationId: issues/delete-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": get: summary: List reactions for an issue comment description: List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/list-for-issue-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions post: summary: Create reaction for an issue comment description: Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. tags: - reactions operationId: reactions/create-for-issue-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the issue comment. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '200': description: Reaction exists content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '201': description: Reaction created content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": delete: summary: Delete an issue comment reaction description: |- > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). tags: - reactions operationId: reactions/delete-for-issue-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - "$ref": "#/components/parameters/reaction-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/issues/events": get: summary: List issue events for a repository description: Lists events for a repository. tags: - issues operationId: issues/list-events-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue-event" examples: default: "$ref": "#/components/examples/issue-event-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: events "/repos/{owner}/{repo}/issues/events/{event_id}": get: summary: Get an issue event description: Gets a single event by the event id. tags: - issues operationId: issues/get-event externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: event_id in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue-event" examples: default: "$ref": "#/components/examples/issue-event" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: events "/repos/{owner}/{repo}/issues/{issue_number}": get: summary: Get an issue description: |- The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was [transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook. > [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues patch: summary: Update an issue description: |- Issue owners and users with push access or Triage role can edit an issue. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: false content: application/json: schema: type: object properties: title: oneOf: - type: string - type: integer description: The title of the issue. nullable: true body: type: string description: The contents of the issue. nullable: true assignee: type: string nullable: true description: Username to assign to this issue. **This field is closing down.** state: type: string description: The open or closed state of the issue. enum: - open - closed state_reason: type: string enum: - completed - not_planned - duplicate - reopened nullable: true description: The reason for the state change. Ignored unless `state` is changed. example: not_planned milestone: oneOf: - type: string - type: integer description: The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped. nullable: true labels: type: array description: Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. items: oneOf: - type: string - type: object properties: id: type: integer name: type: string description: type: string nullable: true color: type: string nullable: true assignees: type: array description: Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. items: type: string type: type: string description: The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. nullable: true example: Epic examples: default: value: title: Found a bug body: I'm having a problem with this. assignees: - octocat milestone: 1 state: open labels: - bug responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" '422': "$ref": "#/components/responses/validation_failed" '503': "$ref": "#/components/responses/service_unavailable" '403': "$ref": "#/components/responses/forbidden" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues "/repos/{owner}/{repo}/issues/{issue_number}/assignees": post: summary: Add assignees to an issue description: Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. tags: - issues operationId: issues/add-assignees externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: false content: application/json: schema: type: object properties: assignees: type: array description: 'Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._' items: type: string examples: default: value: assignees: - hubot - other_user responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees delete: summary: Remove assignees from an issue description: Removes one or more assignees from an issue. tags: - issues operationId: issues/remove-assignees externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: content: application/json: schema: type: object properties: assignees: type: array description: 'Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._' items: type: string examples: default: value: assignees: - hubot - other_user responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": get: summary: Check if a user can be assigned to a issue description: |- Checks if a user has permission to be assigned to a specific issue. If the `assignee` can be assigned to this issue, a `204` status code with no content is returned. Otherwise a `404` status code is returned. tags: - issues operationId: issues/check-user-can-be-assigned-to-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - name: assignee in: path required: true schema: type: string responses: '204': description: Response if `assignee` can be assigned to `issue_number` '404': description: Response if `assignee` can not be assigned to `issue_number` content: application/json: schema: "$ref": "#/components/schemas/basic-error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees "/repos/{owner}/{repo}/issues/{issue_number}/comments": get: summary: List issue comments description: |- You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. Issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-comments externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue-comment" examples: default: "$ref": "#/components/examples/issue-comment-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments post: summary: Create an issue comment description: |- You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/create-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The contents of the comment. required: - body examples: default: value: body: Me too responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue-comment" examples: default: "$ref": "#/components/examples/issue-comment" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': "$ref": "#/components/responses/forbidden" '410': "$ref": "#/components/responses/gone" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": get: summary: List dependencies an issue is blocked by description: |- You can use the REST API to list the dependencies an issue is blocked by. This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-dependencies-blocked-by externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue-items" headers: Link: "$ref": "#/components/headers/link" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issue-dependencies post: summary: Add a dependency an issue is blocked by description: |- You can use the REST API to add a 'blocked by' relationship to an issue. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/add-blocked-by-dependency externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: true content: application/json: schema: type: object properties: issue_id: type: integer description: The id of the issue that blocks the current issue required: - issue_id examples: default: value: issue_id: 1 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string '301': "$ref": "#/components/responses/moved_permanently" '403': "$ref": "#/components/responses/forbidden" '410': "$ref": "#/components/responses/gone" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": delete: summary: Remove dependency an issue is blocked by description: |- You can use the REST API to remove a dependency that an issue is blocked by. Removing content too quickly using this endpoint may result in secondary rate limiting. For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/remove-dependency-blocked-by externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - name: issue_id in: path description: The id of the blocking issue to remove as a dependency required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" '301': "$ref": "#/components/responses/moved_permanently" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": get: summary: List dependencies an issue is blocking description: |- You can use the REST API to list the dependencies an issue is blocking. This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-dependencies-blocking externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue-items" headers: Link: "$ref": "#/components/headers/link" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events description: Lists all events for an issue. tags: - issues operationId: issues/list-events externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue-event-for-issue" examples: default: "$ref": "#/components/examples/issue-event-for-issue-items" headers: Link: "$ref": "#/components/headers/link" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: events "/repos/{owner}/{repo}/issues/{issue_number}/labels": get: summary: List labels for an issue description: Lists all labels for an issue. tags: - issues operationId: issues/list-labels-on-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label-items" headers: Link: "$ref": "#/components/headers/link" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels post: summary: Add labels to an issue description: 'Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. ' tags: - issues operationId: issues/add-labels externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: false content: application/json: schema: oneOf: - type: object properties: labels: type: array minItems: 1 description: The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue)." items: type: string - type: array minItems: 1 items: type: string - type: object properties: labels: type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: string examples: default: value: labels: - bug - enhancement responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label-items" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels put: summary: Set labels for an issue description: Removes any previous labels and sets the new labels for an issue. tags: - issues operationId: issues/set-labels externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: false content: application/json: schema: oneOf: - type: object properties: labels: type: array minItems: 1 description: The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue)." items: type: string - type: array minItems: 1 items: type: string - type: object properties: labels: type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: string examples: default: value: labels: - bug - enhancement responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label-items" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels delete: summary: Remove all labels from an issue description: Removes all labels from an issue. tags: - issues operationId: issues/remove-all-labels externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" responses: '204': description: Response '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": delete: summary: Remove a label from an issue description: Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. tags: - issues operationId: issues/remove-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - name: name in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label-items-2" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels "/repos/{owner}/{repo}/issues/{issue_number}/lock": put: summary: Lock an issue description: |- Users with push access can lock an issue or pull request's conversation. 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](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." tags: - issues operationId: issues/lock externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: false content: application/json: schema: type: object nullable: true properties: lock_reason: type: string description: "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \ \n * `too heated` \n * `resolved` \n * `spam`" enum: - off-topic - too heated - resolved - spam examples: default: summary: Example of locking an issue as off-topic value: lock_reason: off-topic responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '410': "$ref": "#/components/responses/gone" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues delete: summary: Unlock an issue description: Users with push access can unlock an issue's conversation. tags: - issues operationId: issues/unlock externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues "/repos/{owner}/{repo}/issues/{issue_number}/parent": get: summary: Get parent issue description: |- You can use the REST API to get the parent issue of a sub-issue. This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/get-parent externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" '301': "$ref": "#/components/responses/moved_permanently" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/reactions": get: summary: List reactions for an issue description: List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/list-for-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions post: summary: Create reaction for an issue description: Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. tags: - reactions operationId: reactions/create-for-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the issue. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": delete: summary: Delete an issue reaction description: |- > [!NOTE] > You 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](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). tags: - reactions operationId: reactions/delete-for-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/reaction-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": delete: summary: Remove sub-issue description: |- You can use the REST API to remove a sub-issue from an issue. Removing content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/remove-sub-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: true content: application/json: schema: type: object properties: sub_issue_id: type: integer description: The id of the sub-issue to remove required: - sub_issue_id examples: default: value: sub_issue_id: 6 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue schema: type: string '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": get: summary: List sub-issues description: |- You can use the REST API to list the sub-issues on an issue. This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-sub-issues externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: sub-issues post: summary: Add sub-issue description: |- You can use the REST API to add sub-issues to issues. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/add-sub-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: true content: application/json: schema: type: object properties: sub_issue_id: type: integer description: The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue replace_parent: type: boolean description: Option that, when true, instructs the operation to replace the sub-issues current parent issue required: - sub_issue_id examples: default: value: sub_issue_id: 1 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': "$ref": "#/components/responses/forbidden" '410': "$ref": "#/components/responses/gone" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": patch: summary: Reprioritize sub-issue description: You can use the REST API to reprioritize a sub-issue to a different position in the parent list. tags: - issues operationId: issues/reprioritize-sub-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" requestBody: required: true content: application/json: schema: type: object properties: sub_issue_id: type: integer description: The id of the sub-issue to reprioritize after_id: type: integer description: The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). before_id: type: integer description: The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). required: - sub_issue_id examples: default: value: sub_issue_id: 6 after_id: 5 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" '503': "$ref": "#/components/responses/service_unavailable" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/timeline": get: summary: List timeline events for an issue description: List all timeline events for an issue. tags: - issues operationId: issues/list-events-for-timeline externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/timeline-issue-events" examples: default: "$ref": "#/components/examples/timeline-issue-events" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '410': "$ref": "#/components/responses/gone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: timeline "/repos/{owner}/{repo}/keys": get: summary: List deploy keys description: '' tags: - repos operationId: repos/list-deploy-keys externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/deploy-key" examples: default: "$ref": "#/components/examples/deploy-key-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deploy-keys subcategory: deploy-keys post: summary: Create a deploy key description: You can create a read-only deploy key. tags: - repos operationId: repos/create-deploy-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: A name for the key. key: type: string description: The contents of the key. read_only: type: boolean description: "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \ \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/).\"" required: - key examples: default: value: title: octocat@octomac key: ssh-rsa AAA... read_only: true responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/deploy-key" examples: default: "$ref": "#/components/examples/deploy-key" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/keys/1 schema: type: string '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deploy-keys subcategory: deploy-keys "/repos/{owner}/{repo}/keys/{key_id}": get: summary: Get a deploy key description: '' tags: - repos operationId: repos/get-deploy-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/key-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/deploy-key" examples: default: "$ref": "#/components/examples/deploy-key" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: deploy-keys subcategory: deploy-keys delete: summary: Delete a deploy key description: Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. tags: - repos operationId: repos/delete-deploy-key externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/key-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: deploy-keys subcategory: deploy-keys "/repos/{owner}/{repo}/labels": get: summary: List labels for a repository description: Lists all labels for a repository. tags: - issues operationId: issues/list-labels-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels post: summary: Create a label description: Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). tags: - issues operationId: issues/create-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." color: type: string description: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. description: type: string description: A short description of the label. Must be 100 characters or fewer. required: - name examples: default: value: name: bug description: Something isn't working color: f29513 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/labels/bug schema: type: string '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels "/repos/{owner}/{repo}/labels/{name}": get: summary: Get a label description: Gets a label using the given name. tags: - issues operationId: issues/get-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: name in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels patch: summary: Update a label description: Updates a label using the given label name. tags: - issues operationId: issues/update-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: name in: path required: true schema: type: string requestBody: required: false content: application/json: schema: type: object properties: new_name: type: string description: The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." color: type: string description: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. description: type: string description: A short description of the label. Must be 100 characters or fewer. examples: default: value: new_name: 'bug :bug:' description: Small bug fix required color: b01f26 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels delete: summary: Delete a label description: Deletes a label using the given label name. tags: - issues operationId: issues/delete-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: name in: path required: true schema: type: string responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels "/repos/{owner}/{repo}/languages": get: summary: List repository languages description: Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. tags: - repos operationId: repos/list-languages externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/language" examples: default: "$ref": "#/components/examples/language" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/lfs": put: summary: Enable Git LFS for a repository description: |- Enables Git LFS for a repository. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: repos/enable-lfs-for-repo tags: - repos externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '202': "$ref": "#/components/responses/accepted" '403': description: |- We will return a 403 with one of the following messages: - Git LFS support not enabled because Git LFS is globally disabled. - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - Git LFS support not enabled because Git LFS is disabled for . x-github: githubCloudOnly: true enabledForGitHubApps: false category: repos subcategory: lfs delete: summary: Disable Git LFS for a repository description: |- Disables Git LFS for a repository. OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. operationId: repos/disable-lfs-for-repo tags: - repos externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: true enabledForGitHubApps: false category: repos subcategory: lfs "/repos/{owner}/{repo}/license": get: summary: Get the license for a repository description: |- This method returns the contents of the repository's license file, if one is detected. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - licenses operationId: licenses/get-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/git-ref" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/license-content" examples: default: "$ref": "#/components/examples/license-content" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: licenses subcategory: licenses "/repos/{owner}/{repo}/merge-upstream": post: summary: Sync a fork branch with the upstream repository description: Sync a branch of a forked repository to keep it up-to-date with the upstream repository. tags: - repos operationId: repos/merge-upstream externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: branch: type: string description: The name of the branch which should be updated to match upstream. required: - branch examples: default: value: branch: main responses: '200': description: The branch has been successfully synced with the upstream repository content: application/json: schema: "$ref": "#/components/schemas/merged-upstream" examples: default: "$ref": "#/components/examples/merged-upstream" '409': description: The branch could not be synced because of a merge conflict '422': description: The branch could not be synced for some other reason x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branches "/repos/{owner}/{repo}/merges": post: summary: Merge a branch description: '' tags: - repos operationId: repos/merge externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: base: type: string description: The name of the base branch that the head will be merged into. head: type: string description: The head to merge. This can be a branch name or a commit SHA1. commit_message: type: string description: Commit message to use for the merge commit. If omitted, a default message will be used. required: - base - head examples: default: value: base: master head: cool_feature commit_message: Shipped cool_feature! responses: '201': description: Successful Response (The resulting merge commit) content: application/json: schema: "$ref": "#/components/schemas/commit" examples: default: "$ref": "#/components/examples/commit" '204': description: Response when already merged '404': description: Not Found when the base or head does not exist '409': description: Conflict when there is a merge conflict '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: branches subcategory: branches "/repos/{owner}/{repo}/milestones": get: summary: List milestones description: Lists milestones for a repository. tags: - issues operationId: issues/list-milestones externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query required: false schema: type: string enum: - open - closed - all default: open - name: sort description: What to sort results by. Either `due_on` or `completeness`. in: query required: false schema: type: string enum: - due_on - completeness default: due_on - name: direction description: The direction of the sort. Either `asc` or `desc`. in: query required: false schema: type: string enum: - asc - desc default: asc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/milestone" examples: default: "$ref": "#/components/examples/milestone-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones post: summary: Create a milestone description: Creates a milestone. tags: - issues operationId: issues/create-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: The title of the milestone. state: type: string description: The state of the milestone. Either `open` or `closed`. enum: - open - closed default: open description: type: string description: A description of the milestone. due_on: type: string format: date-time description: 'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' required: - title examples: default: value: title: v1.0 state: open description: Tracking milestone for version 1.0 due_on: '2012-10-09T23:39:01Z' responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/milestone" examples: default: "$ref": "#/components/examples/milestone" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/milestones/1 schema: type: string '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones "/repos/{owner}/{repo}/milestones/{milestone_number}": get: summary: Get a milestone description: Gets a milestone using the given milestone number. tags: - issues operationId: issues/get-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/milestone-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/milestone" examples: default: "$ref": "#/components/examples/milestone" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones patch: summary: Update a milestone description: '' tags: - issues operationId: issues/update-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/milestone-number" requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The title of the milestone. state: type: string description: The state of the milestone. Either `open` or `closed`. enum: - open - closed default: open description: type: string description: A description of the milestone. due_on: type: string format: date-time description: 'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' examples: default: value: title: v1.0 state: open description: Tracking milestone for version 1.0 due_on: '2012-10-09T23:39:01Z' responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/milestone" examples: default: "$ref": "#/components/examples/milestone" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones delete: summary: Delete a milestone description: Deletes a milestone using the given milestone number. tags: - issues operationId: issues/delete-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/milestone-number" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": get: summary: List labels for issues in a milestone description: Lists labels for issues in a milestone. tags: - issues operationId: issues/list-labels-for-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/milestone-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/label" examples: default: "$ref": "#/components/examples/label-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels "/repos/{owner}/{repo}/notifications": get: summary: List repository notifications for the authenticated user description: Lists all notifications for the current user in the specified repository. tags: - activity operationId: activity/list-repo-notifications-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/all" - "$ref": "#/components/parameters/participating" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/before" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/thread" examples: default: "$ref": "#/components/examples/thread-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications put: summary: Mark repository notifications as read description: Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. tags: - activity operationId: activity/mark-repo-notifications-as-read externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object properties: last_read_at: type: string format: date-time description: 'Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.' examples: default: value: last_read_at: '2019-01-01T00:00:00Z' responses: '202': description: Response content: application/json: schema: type: object properties: message: type: string url: type: string examples: default: value: message: Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background. '205': description: Reset Content x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications "/repos/{owner}/{repo}/pages": get: summary: Get a GitHub Enterprise Cloud Pages site description: |- Gets information about a GitHub Enterprise Cloud Pages site. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/page" examples: default: "$ref": "#/components/examples/page" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages post: summary: Create a GitHub Enterprise Cloud Pages site description: |- Configures a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-pages-site externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object description: The source branch and directory used to publish your Pages site. nullable: true properties: build_type: type: string description: The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. enum: - legacy - workflow source: type: object description: The source branch and directory used to publish your Pages site. properties: branch: type: string description: The repository branch used to publish your site's source files. path: type: string description: 'The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`' enum: - "/" - "/docs" default: "/" required: - branch anyOf: - required: - source - required: - build_type examples: default: value: source: branch: main path: "/docs" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/page" examples: default: "$ref": "#/components/examples/page" '422': "$ref": "#/components/responses/validation_failed" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages put: summary: Update information about a GitHub Enterprise Cloud Pages site description: |- Updates information for a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/update-information-about-pages-site externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: cname: type: string description: Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//pages/configuring-a-custom-domain-for-your-github-pages-site)." nullable: true https_enforced: type: boolean description: Specify whether HTTPS should be enforced for the repository. build_type: type: string description: The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. enum: - legacy - workflow source: anyOf: - type: string description: Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`. enum: - gh-pages - master - master /docs - type: object description: Update the source for the repository. Must include the branch name and path. properties: branch: type: string description: The repository branch used to publish your site's source files. path: type: string description: The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. enum: - "/" - "/docs" required: - branch - path public: type: boolean description: Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. anyOf: - required: - build_type - required: - source - required: - cname - required: - public - required: - https_enforced examples: default: value: cname: octocatblog.com source: branch: main path: "/" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" '400': "$ref": "#/components/responses/bad_request" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages delete: summary: Delete a GitHub Enterprise Cloud Pages site description: |- Deletes a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-pages-site externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/pages/builds": get: summary: List GitHub Enterprise Cloud Pages builds description: |- Lists builts of a GitHub Enterprise Cloud Pages site. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/list-pages-builds externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/page-build" examples: default: "$ref": "#/components/examples/page-build-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages post: summary: Request a GitHub Enterprise Cloud Pages build description: |- You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. tags: - repos operationId: repos/request-pages-build externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/page-build-status" examples: default: "$ref": "#/components/examples/page-build-status" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/pages/builds/latest": get: summary: Get latest Pages build description: |- Gets information about the single most recent build of a GitHub Enterprise Cloud Pages site. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-latest-pages-build externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/page-build" examples: default: "$ref": "#/components/examples/page-build" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/pages/builds/{build_id}": get: summary: Get GitHub Enterprise Cloud Pages build description: |- Gets information about a GitHub Enterprise Cloud Pages build. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages-build externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: build_id in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/page-build" examples: default: "$ref": "#/components/examples/page-build" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/pages/deployments": post: summary: Create a GitHub Pages deployment description: |- Create a GitHub Pages deployment for a repository. The authenticated user must have write permission to the repository. tags: - repos operationId: repos/create-pages-deployment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object description: The object used to create GitHub Pages deployment properties: artifact_id: type: number description: The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. artifact_url: type: string description: The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. environment: type: string description: The target environment for this GitHub Pages deployment. default: github-pages pages_build_version: type: string description: A unique string that represents the version of the build for this deployment. default: GITHUB_SHA oidc_token: type: string description: The OIDC token issued by GitHub Actions certifying the origin of the deployment. required: - pages_build_version - oidc_token examples: default: value: artifact_url: https://downloadcontent/ environment: github-pages pages_build_version: 4fd754f7e594640989b406850d0bc8f06a121251 oidc_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/page-deployment" examples: default: "$ref": "#/components/examples/page-deployment" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": get: summary: Get the status of a GitHub Pages deployment description: |- Gets the current status of a GitHub Pages deployment. The authenticated user must have read permission for the GitHub Pages site. tags: - repos operationId: repos/get-pages-deployment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pages-deployment-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pages-deployment-status" examples: default: "$ref": "#/components/examples/pages-deployment-status" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": post: summary: Cancel a GitHub Pages deployment description: |- Cancels a GitHub Pages deployment. The authenticated user must have write permissions for the GitHub Pages site. tags: - repos operationId: repos/cancel-pages-deployment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pages-deployment-id" responses: '204': "$ref": "#/components/responses/no_content" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/pages/health": get: summary: Get a DNS health check for GitHub Pages description: |- Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages-health-check externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pages-health-check" examples: default: "$ref": "#/components/examples/pages-health-check" '202': description: Empty response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '400': description: Custom domains are not available for GitHub Pages '422': description: There isn't a CNAME for this page '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pages subcategory: pages "/repos/{owner}/{repo}/private-vulnerability-reporting": get: summary: Check if private vulnerability reporting is enabled for a repository description: Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". tags: - repos operationId: repos/check-private-vulnerability-reporting externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Private vulnerability reporting status content: application/json: schema: type: object properties: enabled: type: boolean description: Whether or not private vulnerability reporting is enabled for the repository. required: - enabled examples: default: value: enabled: true '422': "$ref": "#/components/responses/bad_request" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos put: summary: Enable private vulnerability reporting for a repository description: Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." tags: - repos operationId: repos/enable-private-vulnerability-reporting externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': "$ref": "#/components/responses/no_content" '422': "$ref": "#/components/responses/bad_request" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos delete: summary: Disable private vulnerability reporting for a repository description: Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". tags: - repos operationId: repos/disable-private-vulnerability-reporting externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': "$ref": "#/components/responses/no_content" '422': "$ref": "#/components/responses/bad_request" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository description: |- Gets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint. tags: - repos operationId: repos/custom-properties-for-repos-get-repository-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/custom-property-value" examples: default: "$ref": "#/components/examples/custom-property-values" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: custom-properties patch: summary: Create or update custom property values for a repository description: |- Create new or update existing custom property values for a repository. Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. tags: - repos operationId: repos/custom-properties-for-repos-create-or-update-repository-values externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: properties: type: array description: A list of custom property names and associated values to apply to the repositories. items: "$ref": "#/components/schemas/custom-property-value" required: - properties examples: default: "$ref": "#/components/examples/create-or-update-custom-properties-values" responses: '204': description: No Content when custom property values are successfully created or updated '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests description: |- Lists pull requests in a specified repository. Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query required: false schema: type: string enum: - open - closed - all default: open - name: head description: 'Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.' in: query required: false schema: type: string - name: base description: 'Filter pulls by base branch name. Example: `gh-pages`.' in: query required: false schema: type: string - name: sort description: What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. in: query required: false schema: type: string enum: - created - updated - popularity - long-running default: created - name: direction description: 'The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.' in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/pull-request-simple" examples: default: "$ref": "#/components/examples/pull-request-simple-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls post: summary: Create a pull request description: |- Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: The title of the new pull request. Required unless `issue` is specified. head: type: string description: 'The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.' head_repo: type: string description: The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. format: repo.nwo example: octo-org/octo-repo base: type: string description: The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. body: type: string description: The contents of the pull request. maintainer_can_modify: type: boolean description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. draft: type: boolean description: Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/enterprise-cloud@latest//articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. issue: type: integer format: int64 example: 1 description: An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. required: - head - base examples: default: value: title: Amazing new feature body: Please pull these awesome changes in! head: octocat:new-feature base: master responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request" examples: default: "$ref": "#/components/examples/pull-request" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 schema: type: string '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls "/repos/{owner}/{repo}/pulls/comments": get: summary: List review comments in a repository description: |- Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-review-comments-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: sort in: query required: false schema: type: string enum: - created - updated - created_at - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/pull-request-review-comment" examples: default: "$ref": "#/components/examples/pull-request-review-comment-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: comments "/repos/{owner}/{repo}/pulls/comments/{comment_id}": get: summary: Get a review comment for a pull request description: |- Provides details for a specified review comment. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/get-review-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review-comment" examples: default: "$ref": "#/components/examples/pull-request-review-comment-2" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: comments patch: summary: Update a review comment for a pull request description: |- Edits the content of a specified review comment. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/update-review-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The text of the reply to the review comment. required: - body examples: default: value: body: I like this too! responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review-comment" examples: default: "$ref": "#/components/examples/pull-request-review-comment-2" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: comments delete: summary: Delete a review comment for a pull request description: Deletes a review comment. tags: - pulls operationId: pulls/delete-review-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: comments "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": get: summary: List reactions for a pull request review comment description: List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/list-for-pull-request-review-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions post: summary: Create reaction for a pull request review comment description: Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. tags: - reactions operationId: reactions/create-for-pull-request-review-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the pull request review comment. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '200': description: Reaction exists content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '201': description: Reaction created content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": delete: summary: Delete a pull request comment reaction description: |- > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). tags: - reactions operationId: reactions/delete-for-pull-request-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/comment-id" - "$ref": "#/components/parameters/reaction-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/pulls/{pull_number}": get: summary: Get a pull request description: |- Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists details of a pull request by providing its number. When you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. tags: - pulls operationId: pulls/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" responses: '200': description: Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. content: application/json: schema: "$ref": "#/components/schemas/pull-request" examples: default: "$ref": "#/components/examples/pull-request" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '406': "$ref": "#/components/responses/unacceptable" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls patch: summary: Update a pull request description: |- Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The title of the pull request. body: type: string description: The contents of the pull request. state: type: string description: State of this Pull Request. Either `open` or `closed`. enum: - open - closed base: type: string description: The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. maintainer_can_modify: type: boolean description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-cloud@latest//articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. examples: default: value: title: new title body: updated body state: open base: master responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request" examples: default: "$ref": "#/components/examples/pull-request" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request description: |- Creates a codespace owned by the authenticated user for the specified pull request. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-with-pr-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: true content: application/json: schema: type: object nullable: true properties: location: description: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. type: string geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. type: string enum: - EuropeWest - SoutheastAsia - UsEast - UsWest client_ip: description: IP for location auto-detection when proxying a request type: string machine: description: Machine type to use for this codespace type: string devcontainer_path: description: Path to devcontainer.json config to use for this codespace type: string multi_repo_permissions_opt_out: description: Whether to authorize requested permissions from devcontainer.json type: boolean working_directory: description: Working directory for this codespace type: string idle_timeout_minutes: description: Time in minutes before codespace stops from inactivity type: integer display_name: description: Display name for this codespace type: string retention_period_minutes: description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). type: integer examples: default: value: repository_id: 1 ref: main responses: '201': description: Response when the codespace was successfully created content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/repos/{owner}/{repo}/pulls/{pull_number}/comments": get: summary: List review comments on a pull request description: |- Lists all review comments for a specified pull request. By default, review comments are in ascending order by ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-review-comments externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/sort" - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/pull-request-review-comment" examples: default: "$ref": "#/components/examples/pull-request-review-comment-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: comments post: summary: Create a review comment for a pull request description: |- Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment)." If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-review-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The text of the review comment. commit_id: type: string description: The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. path: type: string description: The relative path to the file that necessitates a comment. position: type: integer description: '**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.' deprecated: true x-github: deprecationDate: '2022-11-01' side: type: string description: In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/enterprise-cloud@latest//articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. enum: - LEFT - RIGHT line: type: integer description: "**Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." start_line: type: integer description: '**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation.' start_side: type: string description: '**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context.' enum: - LEFT - RIGHT - side in_reply_to: type: integer example: 2 description: The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. subject_type: type: string description: The level at which the comment is targeted. enum: - line - file required: - body - commit_id - path examples: example-for-a-multi-line-comment: summary: Example for a multi-line comment value: body: Great stuff! commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e path: file1.txt start_line: 1 start_side: RIGHT line: 2 side: RIGHT responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review-comment" examples: example-for-a-multi-line-comment: "$ref": "#/components/examples/pull-request-review-comment-example-for-a-multi-line-comment" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 schema: type: string '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: comments "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": post: summary: Create a reply for a review comment description: |- Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-reply-for-review-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/comment-id" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The text of the review comment. required: - body examples: default: value: body: Great stuff! responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review-comment" examples: default: "$ref": "#/components/examples/pull-request-review-comment" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 schema: type: string '404': "$ref": "#/components/responses/not_found" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: false category: pulls subcategory: comments "/repos/{owner}/{repo}/pulls/{pull_number}/commits": get: summary: List commits on a pull request description: |- Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits) endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-commits externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/commit" examples: default: "$ref": "#/components/examples/commit-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/files": get: summary: List pull requests files description: |- Lists the files in a specified pull request. > [!NOTE] > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-files externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/diff-entry" examples: default: "$ref": "#/components/examples/diff-entry-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/merge": get: summary: Check if a pull request has been merged description: Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. tags: - pulls operationId: pulls/check-if-merged externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" responses: '204': description: Response if pull request has been merged '404': description: Not Found if pull request has not been merged x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls put: summary: Merge a pull request description: |- Merges a pull request into the base branch. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." tags: - pulls operationId: pulls/merge externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: false content: application/json: schema: type: object nullable: true properties: commit_title: type: string description: Title for the automatic commit message. commit_message: type: string description: Extra detail to append to automatic commit message. sha: type: string description: SHA that pull request head must match to allow merge. merge_method: type: string description: The merge method to use. enum: - merge - squash - rebase examples: response-if-merge-was-successful: value: commit_title: Expand enum commit_message: Add a new value to the merge_method enum responses: '200': description: if merge was successful content: application/json: schema: "$ref": "#/components/schemas/pull-request-merge-result" examples: response-if-merge-was-successful: "$ref": "#/components/examples/pull-request-merge-result-response-if-merge-was-successful" '405': description: Method Not Allowed if merge cannot be performed content: application/json: schema: type: object properties: message: type: string documentation_url: type: string examples: response-if-merge-cannot-be-performed: value: message: Pull Request is not mergeable '409': description: Conflict if sha was provided and pull request head did not match content: application/json: schema: type: object properties: message: type: string documentation_url: type: string examples: response-if-sha-was-provided-and-pull-request-head-did-not-match: value: message: Head branch was modified. Review and try the merge again. '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: summary: Get all requested reviewers for a pull request description: Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request) operation. tags: - pulls operationId: pulls/list-requested-reviewers externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review-request" examples: default: "$ref": "#/components/examples/simple-pull-request-review-request" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: review-requests post: summary: Request reviewers for a pull request description: |- Requests reviews for a pull request from a given set of users and/or teams. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." tags: - pulls operationId: pulls/request-reviewers externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: false content: application/json: schema: type: object properties: reviewers: type: array description: An array of user `login`s that will be requested. items: type: string team_reviewers: type: array description: An array of team `slug`s that will be requested. items: type: string anyOf: - required: - reviewers - required: - team_reviewers examples: default: value: reviewers: - octocat - hubot - other_user team_reviewers: - justice-league responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-simple" examples: default: "$ref": "#/components/examples/pull-request-review-request" '422': description: Unprocessable Entity if user is not a collaborator '403': "$ref": "#/components/responses/forbidden" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: review-requests delete: summary: Remove requested reviewers from a pull request description: Removes review requests from a pull request for a given set of users and/or teams. tags: - pulls operationId: pulls/remove-requested-reviewers externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: true content: application/json: schema: type: object properties: reviewers: type: array description: An array of user `login`s that will be removed. items: type: string team_reviewers: type: array description: An array of team `slug`s that will be removed. items: type: string required: - reviewers examples: default: value: reviewers: - octocat - hubot - other_user team_reviewers: - justice-league responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-simple" examples: default: "$ref": "#/components/examples/pull-request-simple" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: review-requests "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": get: summary: List reviews for a pull request description: |- Lists all reviews for a specified pull request. The list of reviews returns in chronological order. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-reviews externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: The list of reviews returns in chronological order. content: application/json: schema: type: array items: "$ref": "#/components/schemas/pull-request-review" examples: default: "$ref": "#/components/examples/pull-request-review-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews post: summary: Create a review for a pull request description: |- Creates a review on a specified pull request. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." > [!NOTE] > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-review externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: false content: application/json: schema: type: object properties: commit_id: type: string description: The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. body: type: string description: "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review." event: type: string description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.' enum: - APPROVE - REQUEST_CHANGES - COMMENT comments: type: array description: Use the following table to specify the location, destination, and contents of the draft review comment. items: type: object properties: path: type: string description: The relative path to the file that necessitates a review comment. position: type: integer description: The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. body: type: string description: Text of the review comment. line: type: integer example: 28 side: type: string example: RIGHT start_line: type: integer example: 26 start_side: type: string example: LEFT required: - path - body examples: default: value: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 body: This is close to perfect! Please address the suggested inline change. event: REQUEST_CHANGES comments: - path: file.md position: 6 body: Please add more information here, and fix this typo. responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review" examples: default: "$ref": "#/components/examples/pull-request-review" '422': "$ref": "#/components/responses/validation_failed_simple" '403': "$ref": "#/components/responses/forbidden" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": get: summary: Get a review for a pull request description: |- Retrieves a pull request review by its ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/get-review externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/review-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review" examples: default: "$ref": "#/components/examples/pull-request-review-4" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews put: summary: Update a review for a pull request description: |- Updates the contents of a specified review summary comment. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/update-review externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/review-id" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The body text of the pull request review. required: - body examples: default: value: body: This is close to perfect! Please address the suggested inline change. And add more about this. responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review" examples: default: "$ref": "#/components/examples/pull-request-review-5" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews delete: summary: Delete a pending review for a pull request description: |- Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/delete-pending-review externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/review-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review" examples: default: "$ref": "#/components/examples/pull-request-review" '422': "$ref": "#/components/responses/validation_failed_simple" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": get: summary: List comments for a pull request review description: |- Lists comments for a specific pull request review. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-comments-for-review externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/review-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/review-comment" examples: default: "$ref": "#/components/examples/review-comment-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": put: summary: Dismiss a review for a pull request description: |- Dismisses a specified review on a pull request. > [!NOTE] > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/dismiss-review externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/review-id" requestBody: required: true content: application/json: schema: type: object properties: message: type: string description: The message for the pull request review dismissal event: type: string example: '"DISMISS"' enum: - DISMISS required: - message examples: default: value: message: You are dismissed event: DISMISS responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review" examples: default: "$ref": "#/components/examples/pull-request-review-3" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": post: summary: Submit a review for a pull request description: |- Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/submit-review externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - "$ref": "#/components/parameters/review-id" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The body text of the pull request review event: type: string description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.' enum: - APPROVE - REQUEST_CHANGES - COMMENT required: - event examples: default: value: body: Here is the body for the review. event: REQUEST_CHANGES responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/pull-request-review" examples: default: "$ref": "#/components/examples/pull-request-review-4" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: pulls subcategory: reviews "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": put: summary: Update a pull request branch description: |- Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. tags: - pulls operationId: pulls/update-branch externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" requestBody: required: false content: application/json: schema: type: object nullable: true properties: expected_head_sha: type: string description: 'The expected SHA of the pull request''s HEAD ref. This is the most recent commit on the pull request''s branch. If the expected SHA does not match the pull request''s HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request''s current HEAD ref.' examples: default: value: expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e responses: '202': description: Response content: application/json: schema: type: object properties: message: type: string url: type: string examples: default: value: message: Updating pull request branch. url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: pulls subcategory: pulls "/repos/{owner}/{repo}/readme": get: summary: Get a repository README description: |- Gets the preferred README for a repository. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - repos operationId: repos/get-readme externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/content-file" examples: default: "$ref": "#/components/examples/content-file" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: contents "/repos/{owner}/{repo}/readme/{dir}": get: summary: Get a repository README for a directory description: |- Gets the README from a repository directory. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - repos operationId: repos/get-readme-in-directory externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: dir description: The alternate path to look for a README file in: path required: true schema: type: string x-multi-segment: true - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/content-file" examples: default: "$ref": "#/components/examples/content-file" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases description: |- This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags). Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. tags: - repos operationId: repos/list-releases externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/release" examples: default: "$ref": "#/components/examples/release-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases post: summary: Create a release description: |- Users with push access to the repository can create a release. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." tags: - repos operationId: repos/create-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: tag_name: type: string description: The name of the tag. target_commitish: type: string description: 'Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository''s default branch.' name: type: string description: The name of the release. body: type: string description: Text describing the contents of the tag. draft: type: boolean description: "`true` to create a draft (unpublished) release, `false` to create a published one." default: false prerelease: type: boolean description: "`true` to identify the release as a prerelease. `false` to identify the release as a full release." default: false discussion_category_name: type: string description: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." generate_release_notes: type: boolean description: Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. default: false make_latest: type: string description: Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. enum: - 'true' - 'false' - legacy default: 'true' required: - tag_name examples: default: value: tag_name: v1.0.0 target_commitish: master name: v1.0.0 body: Description of the release draft: false prerelease: false generate_release_notes: false responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/release" examples: default: "$ref": "#/components/examples/release" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/releases/1 schema: type: string '404': description: Not Found if the discussion category name is invalid content: application/json: schema: "$ref": "#/components/schemas/basic-error" '422': "$ref": "#/components/responses/validation_failed" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases "/repos/{owner}/{repo}/releases/assets/{asset_id}": get: summary: Get a release asset description: "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response." tags: - repos operationId: repos/get-release-asset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/asset-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/release-asset" examples: default: "$ref": "#/components/examples/release-asset" '404': "$ref": "#/components/responses/not_found" '302': "$ref": "#/components/responses/found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: assets patch: summary: Update a release asset description: Users with push access to the repository can edit a release asset. tags: - repos operationId: repos/update-release-asset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/asset-id" requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: The file name of the asset. label: type: string description: An alternate short description of the asset. Used in place of the filename. state: type: string example: '"uploaded"' examples: default: value: name: foo-1.0.0-osx.zip label: Mac binary responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/release-asset" examples: default: "$ref": "#/components/examples/release-asset" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: assets delete: summary: Delete a release asset description: '' tags: - repos operationId: repos/delete-release-asset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/asset-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: assets "/repos/{owner}/{repo}/releases/generate-notes": post: summary: Generate release notes content for a release description: Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. tags: - repos operationId: repos/generate-release-notes externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: tag_name: type: string description: The tag name for the release. This can be an existing tag or a new one. target_commitish: type: string description: Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. previous_tag_name: type: string description: The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. configuration_file_path: type: string description: Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. required: - tag_name examples: default: value: tag_name: v1.0.0 target_commitish: main previous_tag_name: v0.9.2 configuration_file_path: ".github/custom_release_config.yml" responses: '200': description: Name and body of generated release notes content: application/json: schema: "$ref": "#/components/schemas/release-notes-content" examples: default: "$ref": "#/components/examples/release-notes-content" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases "/repos/{owner}/{repo}/releases/latest": get: summary: Get the latest release description: |- View the latest published full release for the repository. The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. tags: - repos operationId: repos/get-latest-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/release" examples: default: "$ref": "#/components/examples/release" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases "/repos/{owner}/{repo}/releases/tags/{tag}": get: summary: Get a release by tag name description: Get a published release with the specified tag. tags: - repos operationId: repos/get-release-by-tag externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag description: tag parameter in: path required: true schema: type: string x-multi-segment: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/release" examples: default: "$ref": "#/components/examples/release" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases "/repos/{owner}/{repo}/releases/{release_id}": get: summary: Get a release description: |- Gets a public release with the specified release ID. > [!NOTE] > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." tags: - repos operationId: repos/get-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" responses: '200': description: '**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: schema: "$ref": "#/components/schemas/release" examples: default: "$ref": "#/components/examples/release" '401': description: Unauthorized x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases patch: summary: Update a release description: Users with push access to the repository can edit a release. tags: - repos operationId: repos/update-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" requestBody: required: false content: application/json: schema: type: object properties: tag_name: type: string description: The name of the tag. target_commitish: type: string description: 'Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository''s default branch.' name: type: string description: The name of the release. body: type: string description: Text describing the contents of the tag. draft: type: boolean description: "`true` makes the release a draft, and `false` publishes the release." prerelease: type: boolean description: "`true` to identify the release as a prerelease, `false` to identify the release as a full release." make_latest: type: string description: Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. enum: - 'true' - 'false' - legacy default: true discussion_category_name: type: string description: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/enterprise-cloud@latest//discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." examples: default: value: tag_name: v1.0.0 target_commitish: master name: v1.0.0 body: Description of the release draft: false prerelease: false responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/release" examples: default: "$ref": "#/components/examples/release" '404': description: Not Found if the discussion category name is invalid content: application/json: schema: "$ref": "#/components/schemas/basic-error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases delete: summary: Delete a release description: Users with push access to the repository can delete a release. tags: - repos operationId: repos/delete-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: releases "/repos/{owner}/{repo}/releases/{release_id}/assets": get: summary: List release assets description: '' tags: - repos operationId: repos/list-release-assets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/release-asset" examples: default: "$ref": "#/components/examples/release-asset-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: assets post: summary: Upload a release asset description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* \ GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* \ To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset." tags: - repos operationId: repos/upload-release-asset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#upload-a-release-asset servers: - url: https://uploads.github.com description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" - name: name in: query required: true schema: type: string - name: label in: query schema: type: string requestBody: required: false content: application/octet-stream: schema: type: string format: binary description: The raw file data examples: default: value: "@example.zip" responses: '201': description: Response for successful upload content: application/json: schema: "$ref": "#/components/schemas/release-asset" examples: response-for-successful-upload: "$ref": "#/components/examples/release-asset-response-for-successful-upload" '422': description: Response if you upload an asset with the same filename as another uploaded asset x-github: githubCloudOnly: false enabledForGitHubApps: true category: releases subcategory: assets "/repos/{owner}/{repo}/releases/{release_id}/reactions": get: summary: List reactions for a release description: List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/list-for-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. in: query required: false schema: type: string enum: - "+1" - laugh - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions post: summary: Create reaction for a release description: 'Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.' tags: - reactions operationId: reactions/create-for-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the release. enum: - "+1" - laugh - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '200': description: Reaction exists content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '201': description: Reaction created content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": delete: summary: Delete a release reaction description: |- > [!NOTE] > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). tags: - reactions operationId: reactions/delete-for-release externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/release-id" - "$ref": "#/components/parameters/reaction-id" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/rules/branches/{branch}": get: summary: Get rules for a branch description: |- Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" enforcement statuses are not returned. tags: - repos operationId: repos/get-branch-rules externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/branch" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-rule-detailed" examples: default: "$ref": "#/components/examples/repository-rule-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules "/repos/{owner}/{repo}/rulesets": get: summary: Get all repository rulesets description: Get all the rulesets for a repository. tags: - repos operationId: repos/get-repo-rulesets externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: includes_parents description: Include rulesets configured at higher levels that apply to this repository in: query required: false schema: type: boolean default: true - "$ref": "#/components/parameters/ruleset-targets" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/repository-ruleset-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" post: summary: Create a repository ruleset description: Create a ruleset for a repository. tags: - repos operationId: repos/create-repo-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: description: Request body required: true content: application/json: schema: type: object properties: name: type: string description: The name of the ruleset. target: type: string description: The target of the ruleset enum: - branch - tag - push default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: type: array description: The actors that can bypass the rules in this ruleset items: "$ref": "#/components/schemas/repository-ruleset-bypass-actor" conditions: "$ref": "#/components/schemas/repository-ruleset-conditions" rules: type: array description: An array of rules within the ruleset. items: "$ref": "#/components/schemas/repository-rule" required: - name - enforcement examples: default: value: name: super cool ruleset target: branch enforcement: active bypass_actors: - actor_id: 234 actor_type: Team bypass_mode: always conditions: ref_name: include: - refs/heads/main - refs/heads/master exclude: - refs/heads/dev* rules: - type: commit_author_email_pattern parameters: operator: contains pattern: github responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/repository-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites description: |- Lists suites of rule evaluations at the repository level. For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-repo-rule-suites externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/ref-in-query" - "$ref": "#/components/parameters/time-period" - "$ref": "#/components/parameters/actor-name-in-query" - "$ref": "#/components/parameters/rule-suite-result" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/rule-suites" examples: default: "$ref": "#/components/examples/rule-suite-items" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rule-suites "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": get: summary: Get a repository rule suite description: |- Gets information about a suite of rule evaluations from within a repository. For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." tags: - repos operationId: repos/get-repo-rule-suite externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/rule-suite-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/rule-suite" examples: default: "$ref": "#/components/examples/rule-suite" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rule-suites "/repos/{owner}/{repo}/rulesets/{ruleset_id}": get: summary: Get a repository ruleset description: |- Get a ruleset for a repository. **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user making the API request has write access to the ruleset. tags: - repos operationId: repos/get-repo-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer - name: includes_parents description: Include rulesets configured at higher levels that apply to this repository in: query required: false schema: type: boolean default: true responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/repository-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" put: summary: Update a repository ruleset description: Update a ruleset for a repository. tags: - repos operationId: repos/update-repo-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#update-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer requestBody: description: Request body required: false content: application/json: schema: type: object properties: name: type: string description: The name of the ruleset. target: type: string description: The target of the ruleset enum: - branch - tag - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: type: array description: The actors that can bypass the rules in this ruleset items: "$ref": "#/components/schemas/repository-ruleset-bypass-actor" conditions: "$ref": "#/components/schemas/repository-ruleset-conditions" rules: description: An array of rules within the ruleset. type: array items: "$ref": "#/components/schemas/repository-rule" examples: default: value: name: super cool ruleset target: branch enforcement: active bypass_actors: - actor_id: 234 actor_type: Team bypass_mode: always conditions: ref_name: include: - refs/heads/main - refs/heads/master exclude: - refs/heads/dev* rules: - type: commit_author_email_pattern parameters: operator: contains pattern: github responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-ruleset" examples: default: "$ref": "#/components/examples/repository-ruleset" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. tags: - repos operationId: repos/delete-repo-ruleset externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history description: Get the history of a repository ruleset. tags: - repos operationId: repos/get-repo-ruleset-history externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/ruleset-version" examples: default: "$ref": "#/components/examples/ruleset-history" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": get: summary: Get repository ruleset version description: Get a version of a repository ruleset. tags: - repos operationId: repos/get-repo-ruleset-version externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ruleset_id description: The ID of the ruleset. in: path required: true schema: type: integer - name: version_id description: The ID of the version in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/ruleset-version-with-state" examples: default: "$ref": "#/components/examples/repository-ruleset-version-with-state" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: rules "/repos/{owner}/{repo}/secret-scanning/alerts": get: summary: List secret scanning alerts for a repository description: |- Lists secret scanning alerts for an eligible repository, from newest to oldest. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning operationId: secret-scanning/list-alerts-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" - "$ref": "#/components/parameters/secret-scanning-alert-validity" - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/secret-scanning-alert" examples: default: "$ref": "#/components/examples/secret-scanning-alert-list" '404': description: Repository is public or secret scanning is disabled for the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": get: summary: Get a secret scanning alert description: |- Gets a single secret scanning alert detected in an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning operationId: secret-scanning/get-alert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-alert" examples: default: "$ref": "#/components/examples/secret-scanning-alert-open" '304': "$ref": "#/components/responses/not_modified" '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning patch: summary: Update a secret scanning alert description: |- Updates the status of a secret scanning alert in an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. operationId: secret-scanning/update-alert tags: - secret-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" requestBody: required: true content: application/json: schema: type: object properties: state: "$ref": "#/components/schemas/secret-scanning-alert-state" resolution: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" anyOf: - required: - state examples: default: value: state: resolved resolution: false_positive responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-alert" examples: default: "$ref": "#/components/examples/secret-scanning-alert-resolved" '400': description: Bad request, resolution comment is invalid or the resolution was not changed. '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': description: State does not match the resolution or resolution comment '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: secret-scanning subcategory: secret-scanning "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": get: summary: List locations for a secret scanning alert description: |- Lists all locations for a given secret scanning alert for an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning operationId: secret-scanning/list-locations-for-alert externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array description: List of locations where the secret was detected items: "$ref": "#/components/schemas/secret-scanning-location" examples: default: "$ref": "#/components/examples/secret-scanning-location-list" headers: Link: "$ref": "#/components/headers/link" '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass description: |- Creates a bypass for a previously push protected secret. The authenticated user must be the original author of the committed secret. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: secret-scanning/create-push-protection-bypass tags: - secret-scanning externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: reason: "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" placeholder_id: "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" required: - reason - placeholder_id examples: default: value: reason: will_fix_later placeholder_id: 2k4dM4tseyC5lPIsjl5emX9sPNk responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-push-protection-bypass" examples: default: "$ref": "#/components/examples/secret-scanning-push-protection-bypass" '403': description: User does not have enough permissions to perform this action. '404': description: Placeholder ID not found, or push protection is disabled on this repository. '422': description: Bad request, input data missing or incorrect. '503': "$ref": "#/components/responses/service_unavailable" x-github: enabledForGitHubApps: true githubCloudOnly: false category: secret-scanning subcategory: secret-scanning "/repos/{owner}/{repo}/secret-scanning/scan-history": get: summary: Get secret scanning scan history for a repository description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. > [!NOTE] > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning operationId: secret-scanning/get-scan-history externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled '503': "$ref": "#/components/responses/service_unavailable" '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/secret-scanning-scan-history" examples: default: "$ref": "#/components/examples/secret-scanning-scan-history" x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning "/repos/{owner}/{repo}/security-advisories": get: summary: List repository security advisories description: |- Lists security advisories in a repository. The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. tags: - security-advisories operationId: security-advisories/list-repository-advisories externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/direction" - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated - published default: created - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 30 - name: state description: Filter by state of the repository advisories. Only advisories of this state will be returned. in: query required: false schema: type: string enum: - triage - draft - published - closed responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-advisory" examples: default: "$ref": "#/components/examples/list-repository-advisories" '400': "$ref": "#/components/responses/bad_request" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories post: summary: Create a repository security advisory description: |- Creates a new repository security advisory. In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/create-repository-advisory externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/repository-advisory-create" examples: default: value: summary: A new important advisory description: A more in-depth description of what the problem is. severity: high cve_id: vulnerabilities: - package: name: a-package ecosystem: npm vulnerable_version_range: "< 1.0.0" patched_versions: 1.0.0 vulnerable_functions: - important_function cwe_ids: - CWE-1101 - CWE-20 credits: - login: monalisa type: reporter - login: octocat type: analyst withVectorString: value: summary: A new important advisory description: A more in-depth description of what the problem is. cvss_vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:L cve_id: vulnerabilities: - package: name: a-package ecosystem: npm vulnerable_version_range: "< 1.0.0" patched_versions: 1.0.0 vulnerable_functions: - important_function cwe_ids: - CWE-1101 - CWE-20 credits: - login: monalisa type: reporter - login: octocat type: analyst minimal: value: summary: A new important advisory description: A more in-depth description of what the problem is. vulnerabilities: - package: ecosystem: npm responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-advisory" examples: default: "$ref": "#/components/examples/repository-advisory" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories "/repos/{owner}/{repo}/security-advisories/reports": post: summary: Privately report a security vulnerability description: |- Report a security vulnerability to the maintainers of the repository. See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. tags: - security-advisories operationId: security-advisories/create-private-vulnerability-report externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/private-vulnerability-report-create" examples: default: value: summary: A newly discovered vulnerability description: A more in-depth description of what the problem is. severity: high vulnerabilities: - package: name: a-package ecosystem: npm vulnerable_version_range: "< 1.0.0" patched_versions: 1.0.0 vulnerable_functions: - important_function cwe_ids: - CWE-123 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-advisory" examples: default: "$ref": "#/components/examples/repository-advisory-pvr" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": get: summary: Get a repository security advisory description: |- Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. Anyone can access any published security advisory on a public repository. The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on the security advisory. OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. tags: - security-advisories operationId: security-advisories/get-repository-advisory externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/ghsa_id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-advisory" examples: default: "$ref": "#/components/examples/repository-advisory" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories patch: summary: Update a repository security advisory description: |- Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, or a collaborator on the repository security advisory. OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/update-repository-advisory externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/ghsa_id" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/repository-advisory-update" examples: default: summary: Updating the severity and state. value: severity: critical state: published add_credit: summary: To add a credit to an advisory, send the whole array of values. value: credits: - login: monauser type: remediation_developer update_vvrs: summary: To add vulnerable versions, include existing versions in the array. value: - package: ecosystem: pip name: a-package vulnerable_version_range: ">= 1.0.0, < 1.0.1" patched_versions: 1.0.1 vulnerable_functions: - function1 - package: ecosystem: pip name: another-package vulnerable_version_range: ">= 1.0.0, < 1.0.2" patched_versions: 1.0.2 vulnerable_functions: - function2 invalid_state_transition: summary: Example of an invalid state transition, from `published` to `draft`. value: state: draft update_severity_with_cvss_set: summary: Severity cannot be updated when the CVSS is already set. value: severity: low responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-advisory" examples: default: "$ref": "#/components/examples/repository-advisory" add_credit: "$ref": "#/components/examples/repository-advisory" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': description: Validation failed, or the endpoint has been spammed. content: application/json: schema: "$ref": "#/components/schemas/validation-error" examples: invalid_state_transition: value: message: Invalid state transition from `published` to `draft`. update_severity_with_cvss_set: value: message: Cannot update severity value when CVSS is set. x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": post: summary: Request a CVE for a repository security advisory description: |- If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." You may request a CVE for public repositories, but cannot do so for private repositories. In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/create-repository-advisory-cve-request externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/ghsa_id" responses: '202': "$ref": "#/components/responses/accepted" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": post: summary: Create a temporary private fork description: |- Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. > [!NOTE] > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. tags: - security-advisories operationId: security-advisories/create-fork externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/ghsa_id" responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/full-repository" examples: default: "$ref": "#/components/examples/full-repository" '400': "$ref": "#/components/responses/bad_request" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories "/repos/{owner}/{repo}/stargazers": get: summary: List stargazers description: |- Lists the people that have starred the repository. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-stargazers-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: anyOf: - type: array items: "$ref": "#/components/schemas/simple-user" - type: array items: "$ref": "#/components/schemas/stargazer" examples: default-response: "$ref": "#/components/examples/simple-user-items-default-response" alternative-response-with-star-creation-timestamps: "$ref": "#/components/examples/stargazer-items-alternative-response-with-star-creation-timestamps" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: starring "/repos/{owner}/{repo}/stats/code_frequency": get: summary: Get the weekly commit activity description: |- Returns a weekly aggregate of the number of additions and deletions pushed to a repository. > [!NOTE] > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. tags: - repos operationId: repos/get-code-frequency-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Returns a weekly aggregate of the number of additions and deletions pushed to a repository. content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-frequency-stat" examples: default: "$ref": "#/components/examples/code-frequency-stat-items" '202': "$ref": "#/components/responses/accepted" '204': "$ref": "#/components/responses/no_content" '422': description: Repository contains more than 10,000 commits x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: statistics "/repos/{owner}/{repo}/stats/commit_activity": get: summary: Get the last year of commit activity description: Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. tags: - repos operationId: repos/get-commit-activity-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/commit-activity" examples: default: "$ref": "#/components/examples/commit-activity-items" '202': "$ref": "#/components/responses/accepted" '204': "$ref": "#/components/responses/no_content" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: statistics "/repos/{owner}/{repo}/stats/contributors": get: summary: Get all contributor commit activity description: |2- Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * `a` - Number of additions * `d` - Number of deletions * `c` - Number of commits > [!NOTE] > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. tags: - repos operationId: repos/get-contributors-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/contributor-activity" examples: default: "$ref": "#/components/examples/contributor-activity-items" '202': "$ref": "#/components/responses/accepted" '204': "$ref": "#/components/responses/no_content" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: statistics "/repos/{owner}/{repo}/stats/participation": get: summary: Get the weekly commit count description: |- Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. The array order is oldest week (index 0) to most recent week. The most recent week is seven days ago at UTC midnight to today at UTC midnight. tags: - repos operationId: repos/get-participation-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: The array order is oldest week (index 0) to most recent week. content: application/json: schema: "$ref": "#/components/schemas/participation-stats" examples: default: "$ref": "#/components/examples/participation-stats" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: statistics "/repos/{owner}/{repo}/stats/punch_card": get: summary: Get the hourly commit count for each day description: |- Each array contains the day number, hour number, and number of commits: * `0-6`: Sunday - Saturday * `0-23`: Hour of day * Number of commits For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. tags: - repos operationId: repos/get-punch-card-stats externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. content: application/json: schema: type: array items: "$ref": "#/components/schemas/code-frequency-stat" examples: default: "$ref": "#/components/examples/code-frequency-stat-items-2" '204': "$ref": "#/components/responses/no_content" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: statistics "/repos/{owner}/{repo}/statuses/{sha}": post: summary: Create a commit status description: |- Users with push access in a repository can create commit statuses for a given SHA. Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. tags: - repos operationId: repos/create-commit-status externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: sha in: path required: true schema: type: string x-multi-segment: true requestBody: required: true content: application/json: schema: type: object properties: state: type: string description: The state of the status. enum: - error - failure - pending - success target_url: type: string nullable: true description: "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \ \n`http://ci.example.com/user/repo/build/sha`" description: type: string nullable: true description: A short description of the status. context: type: string description: A string label to differentiate this status from the status of other systems. This field is case-insensitive. default: default required: - state examples: default: value: state: success target_url: https://example.com/build/status description: The build succeeded! context: continuous-integration/jenkins responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/status" examples: default: "$ref": "#/components/examples/status" headers: Location: example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: commits subcategory: statuses "/repos/{owner}/{repo}/subscribers": get: summary: List watchers description: Lists the people watching the specified repository. tags: - activity operationId: activity/list-watchers-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: watching "/repos/{owner}/{repo}/subscription": get: summary: Get a repository subscription description: Gets information about whether the authenticated user is subscribed to the repository. tags: - activity operationId: activity/get-repo-subscription externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: if you subscribe to the repository content: application/json: schema: "$ref": "#/components/schemas/repository-subscription" examples: response-if-you-subscribe-to-the-repository: "$ref": "#/components/examples/repository-subscription-response-if-you-subscribe-to-the-repository" '404': description: Not Found if you don't subscribe to the repository '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: watching put: summary: Set a repository subscription description: If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription) completely. tags: - activity operationId: activity/set-repo-subscription externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object properties: subscribed: type: boolean description: Determines if notifications should be received from this repository. ignored: type: boolean description: Determines if all notifications should be blocked from this repository. examples: default: value: subscribed: true ignored: false responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/repository-subscription" examples: default: "$ref": "#/components/examples/repository-subscription" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: watching delete: summary: Delete a repository subscription description: 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](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription). tags: - activity operationId: activity/delete-repo-subscription externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: watching "/repos/{owner}/{repo}/tags": get: summary: List repository tags description: '' tags: - repos operationId: repos/list-tags externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/tag" examples: default: "$ref": "#/components/examples/tag-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/tags/protection": get: summary: Closing down - List tag protection states for a repository description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets)" endpoint instead. This returns the tag protection states of a repository. This information is only available to repository administrators. tags: - repos operationId: repos/list-tag-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/tag-protection" examples: default: "$ref": "#/components/examples/tag-protection-items" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: tags deprecationDate: '2024-05-29' removalDate: '2024-08-30' deprecated: true post: summary: Closing down - Create a tag protection state for a repository description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset)" endpoint instead. This creates a tag protection state for a repository. This endpoint is only available to repository administrators. tags: - repos operationId: repos/create-tag-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: pattern: type: string description: An optional glob pattern to match against when enforcing tag protection. required: - pattern examples: default: value: pattern: v1.* responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/tag-protection" examples: default: "$ref": "#/components/examples/tag-protection" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: tags deprecationDate: '2024-05-29' removalDate: '2024-08-30' deprecated: true "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": delete: summary: Closing down - Delete a tag protection state for a repository description: |- > [!WARNING] > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. This deletes a tag protection state for a repository. This endpoint is only available to repository administrators. tags: - repos operationId: repos/delete-tag-protection externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/tag-protection-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: tags deprecationDate: '2024-05-29' removalDate: '2024-08-30' deprecated: true "/repos/{owner}/{repo}/tarball/{ref}": get: summary: Download a repository archive (tar) description: |- Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. > [!NOTE] > For private repositories, these links are temporary and expire after five minutes. tags: - repos externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref in: path required: true x-multi-segment: true schema: type: string responses: '302': description: Response headers: Location: example: https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: contents "/repos/{owner}/{repo}/teams": get: summary: List repository teams description: |- Lists the teams that have access to the specified repository and that are also visible to the authenticated user. For a public repository, a team is listed only if that team added the public repository explicitly. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/list-teams externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: default: "$ref": "#/components/examples/team-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/topics": get: summary: Get all repository topics description: '' tags: - repos operationId: repos/get-all-topics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/topic" examples: default: "$ref": "#/components/examples/topic" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos put: summary: Replace all repository topics description: '' tags: - repos operationId: repos/replace-all-topics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: names: type: array description: An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. items: type: string required: - names examples: default: value: names: - octocat - atom - electron - api responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/topic" examples: default: "$ref": "#/components/examples/topic" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/traffic/clones": get: summary: Get repository clones description: Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. tags: - repos operationId: repos/get-clones externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/clone-traffic" examples: default: "$ref": "#/components/examples/clone-traffic" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: traffic "/repos/{owner}/{repo}/traffic/popular/paths": get: summary: Get top referral paths description: Get the top 10 popular contents over the last 14 days. tags: - repos operationId: repos/get-top-paths externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/content-traffic" examples: default: "$ref": "#/components/examples/content-traffic-items" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: traffic "/repos/{owner}/{repo}/traffic/popular/referrers": get: summary: Get top referral sources description: Get the top 10 referrers over the last 14 days. tags: - repos operationId: repos/get-top-referrers externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/referrer-traffic" examples: default: "$ref": "#/components/examples/referrer-traffic-items" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: traffic "/repos/{owner}/{repo}/traffic/views": get: summary: Get page views description: Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. tags: - repos operationId: repos/get-views externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/view-traffic" examples: default: "$ref": "#/components/examples/view-traffic" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: metrics subcategory: traffic "/repos/{owner}/{repo}/transfer": post: summary: Transfer a repository description: A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/). tags: - repos operationId: repos/transfer externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: true content: application/json: schema: type: object properties: new_owner: type: string description: The username or organization name the repository will be transferred to. new_name: type: string description: The new name to be given to the repository. team_ids: type: array description: ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. items: type: integer required: - new_owner examples: default: value: new_owner: github team_ids: - 12 - 345 new_name: octorepo responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/vulnerability-alerts": get: summary: Check if vulnerability alerts are enabled for a repository description: Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/check-vulnerability-alerts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response if repository is enabled with vulnerability alerts '404': description: Not Found if repository is not enabled with vulnerability alerts x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos put: summary: Enable vulnerability alerts description: Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/enable-vulnerability-alerts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos delete: summary: Disable vulnerability alerts description: |- Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". tags: - repos operationId: repos/disable-vulnerability-alerts externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repos/{owner}/{repo}/zipball/{ref}": get: summary: Download a repository archive (zip) description: |- Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. > [!NOTE] > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. tags: - repos externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref in: path required: true x-multi-segment: true schema: type: string responses: '302': description: Response headers: Location: example: https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: contents "/repos/{template_owner}/{template_repo}/generate": post: summary: Create a repository using a template description: |- Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-using-template externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-using-a-template parameters: - name: template_owner description: The account owner of the template repository. The name is not case sensitive. in: path required: true schema: type: string - name: template_repo description: The name of the template repository without the `.git` extension. The name is not case sensitive. in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: owner: type: string description: The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. name: type: string description: The name of the new repository. description: type: string description: A short description of the new repository. include_all_branches: type: boolean description: 'Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.' default: false private: type: boolean description: Either `true` to create a new private repository or `false` to create a new public one. default: false required: - name examples: default: value: owner: octocat name: Hello-World description: This is your first repository include_all_branches: false private: false responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/full-repository" examples: default: "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World schema: type: string x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/repositories": get: summary: List public repositories description: |- Lists all public repositories in the order that they were created. Note: - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. tags: - repos operationId: repos/list-public externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-public-repositories parameters: - "$ref": "#/components/parameters/since-repo" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/public-repository-items" headers: Link: example: ; rel="next" schema: type: string '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/scim/v2/enterprises/{enterprise}/Groups": get: summary: List provisioned SCIM groups for an enterprise description: |- Lists provisioned SCIM groups in an enterprise. You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. operationId: enterprise-admin/list-provisioned-groups-enterprise tags: - enterprise-admin - scim externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter=externalId eq "9138790-10932-109120392-12321"`. in: query required: false schema: type: string examples: displayName: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - "$ref": "#/components/parameters/excluded-attributes" - "$ref": "#/components/parameters/start-index" - "$ref": "#/components/parameters/count" - "$ref": "#/components/parameters/enterprise" responses: '200': description: Success, either groups were found or not found content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-group-list" examples: default: "$ref": "#/components/examples/scim-enterprise-group-list" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim post: summary: Provision a SCIM enterprise group description: |- Creates a SCIM group for an enterprise. When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. operationId: enterprise-admin/provision-enterprise-group tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-group parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/group" examples: group: value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: Engineering members: - value: 879db59-3bdf-4490-ad68-ab880a2694745 displayName: User 1 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 responses: '201': description: Group has been created content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-group-response" examples: group: "$ref": "#/components/examples/scim-enterprise-group" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '409': "$ref": "#/components/responses/duplicate_record_detected" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": get: summary: Get SCIM provisioning information for an enterprise group description: Gets information about a SCIM group. operationId: enterprise-admin/get-provisioning-information-for-enterprise-group tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - "$ref": "#/components/parameters/scim-group-id" - "$ref": "#/components/parameters/excluded-attributes" - "$ref": "#/components/parameters/enterprise" responses: '200': description: Success, a group was found content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-group-response" examples: default: "$ref": "#/components/examples/scim-enterprise-group" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim put: summary: Set SCIM information for a provisioned enterprise group description: |- Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. operationId: enterprise-admin/set-information-for-provisioned-enterprise-group tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - "$ref": "#/components/parameters/scim-group-id" - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/group" examples: group: summary: Group value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: Engineering groupWithMembers: summary: Group with member value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: Engineering members: - value: 879db59-3bdf-4490-ad68-ab880a2694745 displayName: User 1 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 responses: '200': description: Group was updated content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-group-response" examples: group: "$ref": "#/components/examples/scim-enterprise-group" groupWithMembers: "$ref": "#/components/examples/scim-enterprise-group" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/duplicate_record_detected" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim patch: summary: Update an attribute for a SCIM enterprise group description: |- Update a provisioned group’s individual attributes. To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. You can submit group memberships individually or in batches for improved efficiency. > [!NOTE] > Memberships are referenced via a local user id. Ensure users are created before referencing them here. operationId: enterprise-admin/update-attribute-for-enterprise-group tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - "$ref": "#/components/parameters/scim-group-id" - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/patch-schema" examples: updateGroup: summary: Update Group value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: displayName value: Employees addMembers: summary: Add Members value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: add path: members value: - value: 879db59-3bdf-4490-ad68-ab880a2694745 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 responses: '204': description: Response '200': description: Success, group was updated content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-group-response" examples: updateGroup: "$ref": "#/components/examples/scim-enterprise-group" addMembers: "$ref": "#/components/examples/scim-enterprise-group" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/duplicate_record_detected" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim delete: summary: Delete a SCIM group from an enterprise description: Deletes a SCIM group from an enterprise. operationId: enterprise-admin/delete-scim-group-from-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - "$ref": "#/components/parameters/scim-group-id" - "$ref": "#/components/parameters/enterprise" responses: '204': description: Group was deleted, no content '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim "/scim/v2/enterprises/{enterprise}/Users": get: summary: List SCIM provisioned identities for an enterprise description: |- Lists provisioned SCIM enterprise members. When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. operationId: enterprise-admin/list-provisioned-identities-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise parameters: - name: filter description: If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter=externalId eq "9138790-10932-109120392-12321"`. in: query required: false schema: type: string examples: userName: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - "$ref": "#/components/parameters/start-index" - "$ref": "#/components/parameters/count" - "$ref": "#/components/parameters/enterprise" responses: '200': description: Success, either users were found or not found content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-user-list" examples: default: "$ref": "#/components/examples/scim-enterprise-user-list" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim post: summary: Provision a SCIM enterprise user description: |- Creates an external identity for a new SCIM enterprise user. SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. operationId: enterprise-admin/provision-enterprise-user tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#provision-a-scim-enterprise-user parameters: - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/user" examples: user: "$ref": "#/components/examples/in-user" enterpriseOwner: "$ref": "#/components/examples/in-user-owner" responses: '201': description: User has been created content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-user-response" examples: user: "$ref": "#/components/examples/scim-enterprise-user" enterpriseOwner: "$ref": "#/components/examples/scim-enterprise-user" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '409': "$ref": "#/components/responses/duplicate_record_detected" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": get: summary: Get SCIM provisioning information for an enterprise user description: Gets information about a SCIM user. operationId: enterprise-admin/get-provisioning-information-for-enterprise-user tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - "$ref": "#/components/parameters/scim-user-id" - "$ref": "#/components/parameters/enterprise" responses: '200': description: Success, a user was found content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-user-response" examples: default: "$ref": "#/components/examples/scim-enterprise-user" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim put: summary: Set SCIM information for a provisioned enterprise user description: |- Replaces an existing provisioned user's information. You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. > [!WARNING] > Setting `active: false` will suspend a user, and their handle and email will be obfuscated. operationId: enterprise-admin/set-information-for-provisioned-enterprise-user tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - "$ref": "#/components/parameters/scim-user-id" - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/user" examples: user: "$ref": "#/components/examples/in-user" responses: '200': description: User was updated content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-user-response" examples: user: "$ref": "#/components/examples/scim-enterprise-user" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/duplicate_record_detected" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim patch: summary: Update an attribute for a SCIM enterprise user description: |- Update a provisioned user's individual attributes. To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). > [!NOTE] > Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. > [!WARNING] > Setting `active: false` will suspend a user, and their handle and email will be obfuscated. > ``` > { > "Operations":[{ > "op":"replace", > "value":{ > "active":false > } > }] > } > ``` operationId: enterprise-admin/update-attribute-for-enterprise-user tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - "$ref": "#/components/parameters/scim-user-id" - "$ref": "#/components/parameters/enterprise" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/patch-schema" examples: userMultiValuedProperties: summary: Multi Valued Property value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: emails[type eq 'work'].value value: updatedEmail@microsoft.com - op: replace path: name.familyName value: updatedFamilyName userSingleValuedProperties: summary: Single Valued Property value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: userName value: 5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com - op: replace path: displayName value: Monalisa Octocat disableUser: summary: Disable User value: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: replace path: active value: false responses: '200': description: Success, user was updated content: application/scim+json: schema: "$ref": "#/components/schemas/scim-enterprise-user-response" examples: userMultiValuedProperties: "$ref": "#/components/examples/scim-enterprise-user" userSingleValuedProperties: "$ref": "#/components/examples/scim-enterprise-user" disableUser: "$ref": "#/components/examples/scim-enterprise-user" '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/duplicate_record_detected" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim delete: summary: Delete a SCIM user from an enterprise description: 'Suspends a SCIM user permanently from an enterprise. This action will: remove all the user''s data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user''s emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.' operationId: enterprise-admin/delete-user-from-enterprise tags: - enterprise-admin externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - "$ref": "#/components/parameters/scim-user-id" - "$ref": "#/components/parameters/enterprise" responses: '204': description: User was deleted, no content '400': "$ref": "#/components/responses/scim_bad_request" '401': "$ref": "#/components/responses/authorization_failure" '403': "$ref": "#/components/responses/permission_denied" '404': "$ref": "#/components/responses/not_found" '429': "$ref": "#/components/responses/scim_too_many_requests" '500': "$ref": "#/components/responses/scim_internal_error" x-github: enabledForGitHubApps: true githubCloudOnly: true category: enterprise-admin subcategory: scim "/scim/v2/organizations/{org}/Users": get: summary: List SCIM provisioned identities description: "Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned.\n\nThe returned list of SCIM provisioned identities from the GitHub Enterprise Cloud might not always match the organization or enterprise member list. Here is why that can occur:\n - When an organization invitation is generated by a SCIM integration, this creates an unlinked SCIM identity in the organization. When a user logs into their GitHub user account, visits the organization, and successfully authenticates via SAML, they get added as an organization member and linked to their SAML/SCIM identity in the organization. If the user does not do this, the SCIM identity will remain in the organization, not linked to any organization member.\n - A user's organization membership (inviting and removing a user to/from the organization) should only be managed by a SCIM integration when this is configured for a GitHub organization. If a GitHub user who has a linked SCIM identity is removed from the organization using the GitHub UI or non-SCIM API, as opposed to the SCIM integration, this can leave behind a stale SAML/SCIM identity in the organization for the user. " tags: - scim operationId: scim/list-provisioned-identities externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - "$ref": "#/components/parameters/org" - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query required: false schema: type: integer - name: count description: 'Used for pagination: the number of results to return.' in: query required: false schema: type: integer - name: filter description: |- Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `externalId`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\"Octocat\"`. To filter results for the identity with the email `octocat@github.com`, you would use this query: `?filter=emails%20eq%20\"octocat@github.com\"`. in: query required: false schema: type: string responses: '200': description: Response content: application/scim+json: schema: "$ref": "#/components/schemas/scim-user-list" examples: response-with-filter: "$ref": "#/components/examples/scim-user-list-response-with-filter" response-without-filter: "$ref": "#/components/examples/scim-user-list-response-without-filter" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/scim_not_found" '403': "$ref": "#/components/responses/scim_forbidden" '400': "$ref": "#/components/responses/scim_bad_request" '429': "$ref": "#/components/responses/scim_too_many_requests" x-github: githubCloudOnly: true enabledForGitHubApps: true category: scim subcategory: scim post: summary: Provision and invite a SCIM user description: Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see "[Reinstating a former member of your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." tags: - scim operationId: scim/provision-and-invite-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - "$ref": "#/components/parameters/org" responses: '201': description: Response content: application/scim+json: schema: "$ref": "#/components/schemas/scim-user" examples: default: "$ref": "#/components/examples/scim-user" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/scim_not_found" '403': "$ref": "#/components/responses/scim_forbidden" '500': "$ref": "#/components/responses/scim_internal_error" '409': "$ref": "#/components/responses/scim_conflict" '400': "$ref": "#/components/responses/scim_bad_request" requestBody: required: true content: application/json: schema: type: object properties: userName: description: Configured by the admin. Could be an email, login, or username example: someone@example.com type: string displayName: description: The name of the user, suitable for display to end-users example: Jon Doe type: string name: type: object properties: givenName: type: string familyName: type: string formatted: type: string required: - givenName - familyName example: givenName: Jane familyName: User emails: description: user emails example: - value: someone@example.com primary: true - value: another@example.com primary: false type: array minItems: 1 items: type: object properties: value: type: string primary: type: boolean type: type: string required: - value schemas: type: array items: type: string externalId: type: string groups: type: array items: type: string active: type: boolean required: - userName - name - emails examples: default: value: userName: mona.octocat@okta.example.com externalId: a7d0f98382 name: givenName: Monalisa familyName: Octocat formatted: Monalisa Octocat emails: - value: mona.octocat@okta.example.com primary: true - value: monalisa@octocat.github.com x-github: githubCloudOnly: true enabledForGitHubApps: true category: scim subcategory: scim "/scim/v2/organizations/{org}/Users/{scim_user_id}": get: summary: Get SCIM provisioning information for a user description: Gets SCIM provisioning information for a user. tags: - scim operationId: scim/get-provisioning-information-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/scim-user-id" responses: '200': description: Response content: application/scim+json: schema: "$ref": "#/components/schemas/scim-user" examples: default: "$ref": "#/components/examples/scim-user" '404': "$ref": "#/components/responses/scim_not_found" '403': "$ref": "#/components/responses/scim_forbidden" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: true enabledForGitHubApps: true category: scim subcategory: scim put: summary: Update a provisioned organization membership description: |- Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead. You must at least provide the required values for the user: `userName`, `name`, and `emails`. > [!WARNING] > Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. tags: - scim operationId: scim/set-information-for-provisioned-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/scim-user-id" responses: '200': description: Response content: application/scim+json: schema: "$ref": "#/components/schemas/scim-user" examples: default: "$ref": "#/components/examples/scim-user" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/scim_not_found" '403': "$ref": "#/components/responses/scim_forbidden" requestBody: required: true content: application/json: schema: type: object properties: schemas: type: array items: type: string displayName: description: The name of the user, suitable for display to end-users example: Jon Doe type: string externalId: type: string groups: type: array items: type: string active: type: boolean userName: description: Configured by the admin. Could be an email, login, or username example: someone@example.com type: string name: type: object properties: givenName: type: string familyName: type: string formatted: type: string required: - givenName - familyName example: givenName: Jane familyName: User emails: description: user emails example: - value: someone@example.com primary: true - value: another@example.com primary: false type: array minItems: 1 items: type: object properties: type: type: string value: type: string primary: type: boolean required: - value required: - userName - name - emails examples: default: value: userName: mona.octocat@okta.example.com externalId: a7d0f98382 name: givenName: Monalisa familyName: Octocat formatted: Monalisa Octocat emails: - value: mona.octocat@okta.example.com primary: true x-github: githubCloudOnly: true enabledForGitHubApps: true category: scim subcategory: scim patch: summary: Update an attribute for a SCIM user description: |- Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). > [!NOTE] > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. > [!WARNING] > If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. > ``` > { > "Operations":[{ > "op":"replace", > "value":{ > "active":false > } > }] > } > ``` tags: - scim operationId: scim/update-attribute-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/scim-user-id" responses: '200': description: Response content: application/scim+json: schema: "$ref": "#/components/schemas/scim-user" examples: default: "$ref": "#/components/examples/scim-user" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/scim_not_found" '403': "$ref": "#/components/responses/scim_forbidden" '400': "$ref": "#/components/responses/scim_bad_request" '429': description: Response content: application/json: schema: "$ref": "#/components/schemas/basic-error" requestBody: required: true content: application/json: schema: properties: schemas: type: array items: type: string Operations: description: Set of operations to be performed example: - op: replace value: active: false type: array minItems: 1 items: type: object properties: op: type: string enum: - add - remove - replace path: type: string value: oneOf: - type: object properties: active: type: boolean nullable: true userName: type: string nullable: true externalId: type: string nullable: true givenName: type: string nullable: true familyName: type: string nullable: true - type: array items: type: object properties: value: type: string primary: type: boolean - type: string required: - op required: - Operations type: object examples: default: value: Operations: - op: replace value: displayName: Octocat x-github: githubCloudOnly: true enabledForGitHubApps: true category: scim subcategory: scim delete: summary: Delete a SCIM user from an organization description: Deletes a SCIM user from an organization. tags: - scim operationId: scim/delete-user-from-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/scim-user-id" responses: '204': description: Response '404': "$ref": "#/components/responses/scim_not_found" '403': "$ref": "#/components/responses/scim_forbidden" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: true enabledForGitHubApps: true category: scim subcategory: scim "/search/code": get: summary: Search code description: |- Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: `q=addClass+in:file+language:js+repo:jquery/jquery` This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. Considerations for code search: Due to the complexity of searching code, there are a few restrictions on how searches are performed: * Only the _default branch_ is considered. In most cases, this will be the `master` branch. * Only files smaller than 384 KB are searchable. * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search operationId: search/code externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. in: query required: true schema: type: string - name: sort deprecated: true description: "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)" in: query required: false schema: type: string enum: - indexed - name: order description: "**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. " in: query deprecated: true required: false schema: type: string enum: - desc - asc default: desc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - incomplete_results - items properties: total_count: type: integer incomplete_results: type: boolean items: type: array items: "$ref": "#/components/schemas/code-search-result-item" examples: default: "$ref": "#/components/examples/code-search-result-item-paginated" '304': "$ref": "#/components/responses/not_modified" '503': "$ref": "#/components/responses/service_unavailable" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: search subcategory: search "/search/commits": get: summary: Search commits description: |- Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: `q=repo:octocat/Spoon-Knife+css` tags: - search operationId: search/commits externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-commits parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' in: query required: false schema: type: string enum: - author-date - committer-date - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - incomplete_results - items properties: total_count: type: integer incomplete_results: type: boolean items: type: array items: "$ref": "#/components/schemas/commit-search-result-item" examples: default: "$ref": "#/components/examples/commit-search-result-item-paginated" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: search subcategory: search "/search/issues": get: summary: Search issues and pull requests description: |- Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. `q=windows+label:bug+language:python+state:open&sort=created&order=asc` This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. > [!NOTE] > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." tags: - search operationId: search/issues-and-pull-requests externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-issues-and-pull-requests parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' in: query required: false schema: type: string enum: - comments - reactions - reactions-+1 - reactions--1 - reactions-smile - reactions-thinking_face - reactions-heart - reactions-tada - interactions - created - updated - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - incomplete_results - items properties: total_count: type: integer incomplete_results: type: boolean items: type: array items: "$ref": "#/components/schemas/issue-search-result-item" examples: default: "$ref": "#/components/examples/issue-search-result-item-paginated" '503': "$ref": "#/components/responses/service_unavailable" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true category: search subcategory: search "/search/labels": get: summary: Search labels description: |- Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: `q=bug+defect+enhancement&repository_id=64778136` The labels that best match the query appear first in the search results. tags: - search operationId: search/labels externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-labels parameters: - name: repository_id description: The id of the repository. in: query required: true schema: type: integer - name: q description: The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' in: query required: false schema: type: string enum: - created - updated - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - incomplete_results - items properties: total_count: type: integer incomplete_results: type: boolean items: type: array items: "$ref": "#/components/schemas/label-search-result-item" examples: default: "$ref": "#/components/examples/label-search-result-item-paginated" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: search subcategory: search "/search/repositories": get: summary: Search repositories description: |- Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: `q=tetris+language:assembly&sort=stars&order=desc` This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. tags: - search operationId: search/repos externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-repositories parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)" for a detailed list of qualifiers. in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' in: query required: false schema: type: string enum: - stars - forks - help-wanted-issues - updated - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - incomplete_results - items properties: total_count: type: integer incomplete_results: type: boolean items: type: array items: "$ref": "#/components/schemas/repo-search-result-item" examples: default: "$ref": "#/components/examples/repo-search-result-item-paginated" '503': "$ref": "#/components/responses/service_unavailable" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: search subcategory: search "/search/topics": get: summary: Search topics description: |- Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/)" for a detailed list of qualifiers. When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: `q=ruby+is:featured` This query searches for topics with the keyword `ruby` 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. tags: - search operationId: search/topics externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-topics parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). in: query required: true schema: type: string - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - incomplete_results - items properties: total_count: type: integer incomplete_results: type: boolean items: type: array items: "$ref": "#/components/schemas/topic-search-result-item" examples: default: "$ref": "#/components/examples/topic-search-result-item-paginated" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: search subcategory: search "/search/users": get: summary: Search users description: |- Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For example, if you're looking for a list of popular users, you might try this query: `q=tom+repos:%3E42+followers:%3E1000` This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search)." tags: - search operationId: search/users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-users parameters: - name: q description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. in: query required: true schema: type: string - name: sort description: 'Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)' in: query required: false schema: type: string enum: - followers - repositories - joined - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - incomplete_results - items properties: total_count: type: integer incomplete_results: type: boolean items: type: array items: "$ref": "#/components/schemas/user-search-result-item" examples: default: "$ref": "#/components/examples/user-search-result-item-paginated" '304': "$ref": "#/components/responses/not_modified" '503': "$ref": "#/components/responses/service_unavailable" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: search subcategory: search "/teams/{team_id}": get: summary: Get a team (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. tags: - teams operationId: teams/get-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - "$ref": "#/components/parameters/team-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true patch: summary: Update a team (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. To edit a team, the authenticated user must either be an organization owner or a team maintainer. > [!NOTE] > With nested teams, the `privacy` for parent teams cannot be `secret`. tags: - teams operationId: teams/update-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - "$ref": "#/components/parameters/team-id" requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the team. description: type: string description: The description of the team. privacy: type: string description: "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \ \n * `closed` - visible to all members of this organization. \ \n**For a parent or child team:** \n * `closed` - visible to all members of this organization." enum: - secret - closed notification_setting: type: string description: "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications." enum: - notifications_enabled - notifications_disabled permission: type: string description: "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified." enum: - pull - push - admin default: pull parent_team_id: type: integer description: The ID of a team to set as the parent team. nullable: true required: - name examples: default: value: name: new team name description: new team description privacy: closed notification_setting: notifications_enabled responses: '200': description: Response when the updated information already exists content: application/json: schema: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full" '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true delete: summary: Delete a team (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. To delete a team, the authenticated user must be an organization owner or team maintainer. If you are an organization owner, deleting a parent team will delete all of its child teams as well. tags: - teams operationId: teams/delete-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - "$ref": "#/components/parameters/team-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true "/teams/{team_id}/discussions": get: summary: List discussions (Legacy) description: |- > [!WARNING] > **Endpoint 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`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint. List all discussions on a team's page. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussions-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussions deprecated: true post: summary: Create a discussion (Legacy) description: |- > [!WARNING] > **Endpoint 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 [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint. Creates a new discussion post on a team's page. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - "$ref": "#/components/parameters/team-id" requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: The discussion post's title. body: type: string description: The discussion post's body text. private: type: boolean description: Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. default: false required: - title - body examples: default: value: title: Our first team post body: Hi! This is an area for us to collaborate as a team. responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussions deprecated: true "/teams/{team_id}/discussions/{discussion_number}": get: summary: Get a discussion (Legacy) description: |- > [!WARNING] > **Endpoint 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](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint. Get a specific discussion on a team's page. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussions deprecated: true patch: summary: Update a discussion (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint. Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The discussion post's title. body: type: string description: The discussion post's body text. examples: default: value: title: Welcome to our first team post responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion" examples: default: "$ref": "#/components/examples/team-discussion-2" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussions deprecated: true delete: summary: Delete a discussion (Legacy) description: |- > [!WARNING] > **Endpoint 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 [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint. Delete a discussion from a team's page. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussions deprecated: true "/teams/{team_id}/discussions/{discussion_number}/comments": get: summary: List discussion comments (Legacy) description: |- > [!WARNING] > **Endpoint 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](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint. List all comments on a team discussion. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussion-comments-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussion-comments deprecated: true post: summary: Create a discussion comment (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint. Creates a new comment on a team discussion. This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-comment-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The discussion comment's body text. required: - body examples: default: value: body: Do you like apples? responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment" x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussion-comments deprecated: true "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": get: summary: Get a discussion comment (Legacy) description: |- > [!WARNING] > **Endpoint 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](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint. Get a specific comment on a team discussion. OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-comment-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussion-comments deprecated: true patch: summary: Update a discussion comment (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint. Edits the body text of a discussion comment. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-comment-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The discussion comment's body text. required: - body examples: default: value: body: Do you like pineapples? responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-discussion-comment" examples: default: "$ref": "#/components/examples/team-discussion-comment-2" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussion-comments deprecated: true delete: summary: Delete a discussion comment (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. Deletes a comment on a team discussion. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-comment-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: discussion-comments deprecated: true "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": get: summary: List reactions for a team discussion comment (Legacy) description: |- > [!WARNING] > **Endpoint 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 reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-comment-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-21' deprecationDate: '2020-02-26' category: reactions subcategory: reactions deprecated: true post: summary: Create reaction for a team discussion comment (Legacy) description: |- > [!WARNING] > **Endpoint 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 "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-comment-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - "$ref": "#/components/parameters/comment-number" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion comment. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-21' deprecationDate: '2020-02-26' category: reactions subcategory: reactions deprecated: true "/teams/{team_id}/discussions/{discussion_number}/reactions": get: summary: List reactions for a team discussion (Legacy) description: |- > [!WARNING] > **Endpoint 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 reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. in: query required: false schema: type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-21' deprecationDate: '2020-02-26' category: reactions subcategory: reactions deprecated: true post: summary: Create reaction for a team discussion (Legacy) description: |- > [!WARNING] > **Endpoint 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 [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/discussion-number" requestBody: required: true content: application/json: schema: type: object properties: content: type: string description: The [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions) to add to the team discussion. enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes required: - content examples: default: value: content: heart responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/reaction" examples: default: "$ref": "#/components/examples/reaction" x-github: githubCloudOnly: false enabledForGitHubApps: false removalDate: '2021-02-21' deprecationDate: '2020-02-26' category: reactions subcategory: reactions deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) description: |- > [!WARNING] > **Endpoint 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 pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. tags: - teams operationId: teams/list-pending-invitations-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-invitation" examples: default: "$ref": "#/components/examples/organization-invitation-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true "/teams/{team_id}/members": get: summary: List team members (Legacy) description: |- > [!WARNING] > **Endpoint 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 team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. Team members will include the members of child teams. tags: - teams operationId: teams/list-members-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - "$ref": "#/components/parameters/team-id" - name: role description: Filters members returned by their role in the team. in: query required: false schema: type: string enum: - member - maintainer - all default: all - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true "/teams/{team_id}/members/{username}": get: summary: Get team member (Legacy) description: |- The "Get team member" endpoint (described below) is closing down. We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. To list members in a team, the team must be visible to the authenticated user. tags: - teams operationId: teams/get-member-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/username" responses: '204': description: if user is a member '404': description: if user is not a member x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true put: summary: Add team member (Legacy) description: |- The "Add team member" endpoint (described below) is closing down. We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. > [!NOTE] > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-member-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/username" responses: '204': description: Response '404': description: Not Found if team synchronization is set up '422': description: Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true delete: summary: Remove team member (Legacy) description: |- The "Remove team member" endpoint (described below) is closing down. We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. > [!NOTE] > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-member-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/username" responses: '204': description: Response '404': description: Not Found if team synchronization is setup x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true "/teams/{team_id}/memberships/{username}": get: summary: Get team membership for a user (Legacy) description: |- > [!WARNING] > **Endpoint 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 team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. Team members will include the members of child teams. To get a user's membership with a team, the team must be visible to the authenticated user. **Note:** The response contains the `state` of the membership and the member's `role`. The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). tags: - teams operationId: teams/get-membership-for-user-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-membership" examples: response-if-user-is-a-team-maintainer: "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true put: summary: Add or update team membership for a user (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. > [!NOTE] > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. tags: - teams operationId: teams/add-or-update-membership-for-user-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/username" requestBody: required: false content: application/json: schema: type: object properties: role: type: string description: The role that this user should have in the team. enum: - member - maintainer default: member examples: default: summary: Assign the member role for a user in a team value: role: member responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-membership" examples: response-if-users-membership-with-team-is-now-pending: "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" '403': description: Forbidden if team synchronization is set up '422': description: Unprocessable Entity if you attempt to add an organization to a team '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true delete: summary: Remove team membership for a user (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. > [!NOTE] > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." tags: - teams operationId: teams/remove-membership-for-user-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/username" responses: '204': description: Response '403': description: if team synchronization is set up x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: members deprecated: true "/teams/{team_id}/projects": get: summary: List team projects (Legacy) description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/list-projects-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-project" examples: default: "$ref": "#/components/examples/team-project-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2025-04-01' deprecationDate: '2024-05-23' category: teams subcategory: teams deprecated: true "/teams/{team_id}/projects/{project_id}": get: summary: Check team permissions for a project (Legacy) description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/check-permissions-for-project-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/project-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/team-project" examples: default: "$ref": "#/components/examples/team-project" '404': description: Not Found if project is not managed by this team x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2025-04-01' deprecationDate: '2024-05-23' category: teams subcategory: teams deprecated: true put: summary: Add or update team project permissions (Legacy) description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/add-or-update-project-permissions-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/project-id" requestBody: required: false content: application/json: schema: type: object properties: permission: type: string description: 'The permission to grant to the team for this project. Default: the team''s `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' enum: - read - write - admin examples: default: summary: Example of setting permission to read value: permission: read responses: '204': description: Response '403': description: Forbidden if the project is not owned by the organization content: application/json: schema: type: object properties: message: type: string documentation_url: type: string examples: response-if-the-project-is-not-owned-by-the-organization: value: message: Must have admin rights to Repository. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2025-04-01' deprecationDate: '2024-05-23' category: teams subcategory: teams deprecated: true delete: summary: Remove a project from a team (Legacy) description: |- > [!WARNING] > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. tags: - teams operationId: teams/remove-project-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/project-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2025-04-01' deprecationDate: '2024-05-23' category: teams subcategory: teams deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) description: |- > [!WARNING] > **Endpoint 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 team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. tags: - teams operationId: teams/list-repos-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true "/teams/{team_id}/repos/{owner}/{repo}": get: summary: Check team permissions for a repository (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. > [!NOTE] > Repositories inherited through a parent team will also be checked. You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: tags: - teams operationId: teams/check-permissions-for-repo-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '200': description: Alternative response with extra repository information content: application/json: schema: "$ref": "#/components/schemas/team-repository" examples: alternative-response-with-extra-repository-information: "$ref": "#/components/examples/team-repository-alternative-response-with-extra-repository-information" '204': description: Response if repository is managed by this team '404': description: Not Found if repository is not managed by this team x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true put: summary: Add or update team repository permissions (Legacy) description: |- > [!WARNING] > **Endpoint 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 "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. 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](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-or-update-repo-permissions-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" requestBody: required: false content: application/json: schema: type: object properties: permission: type: string description: The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. enum: - pull - push - admin examples: default: summary: Example of setting permission to pull value: permission: push responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true delete: summary: Remove a repository from a team (Legacy) description: |- > [!WARNING] > **Endpoint 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 [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. tags: - teams operationId: teams/remove-repo-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true "/teams/{team_id}/team-sync/group-mappings": get: summary: List IdP groups for a team (Legacy) description: |- > [!WARNING] > **Endpoint 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 IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. List IdP groups connected to a team on GitHub Enterprise Cloud. tags: - teams operationId: teams/list-idp-groups-for-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - "$ref": "#/components/parameters/team-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/group-mapping" examples: default: "$ref": "#/components/examples/group-mapping-3" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: true enabledForGitHubApps: false removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: team-sync deprecated: true patch: summary: Create or update IdP group connections (Legacy) description: |- > [!WARNING] > **Endpoint 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 [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. tags: - teams operationId: teams/create-or-update-idp-group-connections-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - "$ref": "#/components/parameters/team-id" requestBody: required: true content: application/json: schema: type: object properties: groups: type: array description: The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. items: type: object properties: group_id: type: string description: ID of the IdP group. group_name: type: string description: Name of the IdP group. group_description: type: string description: Description of the IdP group. id: type: string example: '"caceab43fc9ffa20081c"' name: type: string example: '"external-team-6c13e7288ef7"' description: type: string example: '"moar cheese pleese"' required: - group_id - group_name - group_description synced_at: type: string example: '"I am not a timestamp"' required: - groups examples: default: value: groups: - group_id: '123' group_name: Octocat admins description: The people who configure your octoworld. group_description: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/group-mapping" examples: default: "$ref": "#/components/examples/group-mapping-2" '422': "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: true enabledForGitHubApps: false removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: team-sync deprecated: true "/teams/{team_id}/teams": get: summary: List child teams (Legacy) description: |- > [!WARNING] > **Endpoint 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 child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. tags: - teams operationId: teams/list-child-legacy externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - "$ref": "#/components/parameters/team-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: if child teams exist content: application/json: schema: type: array items: "$ref": "#/components/schemas/team" examples: response-if-child-teams-exist: "$ref": "#/components/examples/team-items-response-if-child-teams-exist" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true removalDate: '2021-02-01' deprecationDate: '2020-01-21' category: teams subcategory: teams deprecated: true "/user": get: summary: Get the authenticated user description: OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. tags: - users operationId: users/get-authenticated externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-the-authenticated-user parameters: [] responses: '200': description: Response content: application/json: schema: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" discriminator: propertyName: user_view_type mapping: public: "#/components/schemas/public-user" private: "#/components/schemas/private-user" examples: response-with-public-and-private-profile-information: "$ref": "#/components/examples/private-user-response-with-public-and-private-profile-information" response-with-public-profile-information: "$ref": "#/components/examples/private-user-response-with-public-profile-information" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: users patch: summary: Update the authenticated user description: "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API." tags: - users operationId: users/update-authenticated externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#update-the-authenticated-user parameters: [] requestBody: required: false content: application/json: schema: type: object properties: name: description: The new name of the user. type: string example: Omar Jahandar email: description: The publicly visible email address of the user. type: string example: omar@example.com blog: description: The new blog URL of the user. type: string example: blog.example.com twitter_username: description: The new Twitter username of the user. type: string example: therealomarj nullable: true company: description: The new company of the user. type: string example: Acme corporation location: description: The new location of the user. type: string example: Berlin, Germany hireable: description: The new hiring availability of the user. type: boolean bio: description: The new short biography of the user. type: string examples: default: summary: Example of updating blog and name value: blog: https://github.com/blog name: monalisa octocat responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/private-user" examples: default: "$ref": "#/components/examples/private-user" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: users "/user/blocks": get: summary: List users blocked by the authenticated user description: List the users you've blocked on your personal account. tags: - users operationId: users/list-blocked-by-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#list-users-blocked-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: blocking "/user/blocks/{username}": get: summary: Check if a user is blocked by the authenticated user description: Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. tags: - users operationId: users/check-blocked externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/username" responses: '204': description: If the user is blocked '404': description: If the user is not blocked content: application/json: schema: "$ref": "#/components/schemas/basic-error" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: blocking put: summary: Block a user description: Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. tags: - users operationId: users/block externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - "$ref": "#/components/parameters/username" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: blocking delete: summary: Unblock a user description: Unblocks the given user and returns a 204. tags: - users operationId: users/unblock externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - "$ref": "#/components/parameters/username" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: blocking "/user/codespaces": get: summary: List codespaces for the authenticated user description: |- Lists the authenticated user's codespaces. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/repository-id-in-query" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - codespaces properties: total_count: type: integer codespaces: type: array items: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespaces-list" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces post: summary: Create a codespace for the authenticated user description: |- Creates a new codespace, owned by the authenticated user. This endpoint requires either a `repository_id` OR a `pull_request` but not both. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user requestBody: required: true content: application/json: schema: oneOf: - type: object required: - repository_id properties: repository_id: description: Repository id for this codespace type: integer ref: description: Git ref (typically a branch name) for this codespace type: string location: description: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. type: string geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. type: string enum: - EuropeWest - SoutheastAsia - UsEast - UsWest client_ip: description: IP for location auto-detection when proxying a request type: string machine: description: Machine type to use for this codespace type: string devcontainer_path: description: Path to devcontainer.json config to use for this codespace type: string multi_repo_permissions_opt_out: description: Whether to authorize requested permissions from devcontainer.json type: boolean working_directory: description: Working directory for this codespace type: string idle_timeout_minutes: description: Time in minutes before codespace stops from inactivity type: integer display_name: description: Display name for this codespace type: string retention_period_minutes: description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). type: integer - type: object required: - pull_request properties: pull_request: required: - pull_request_number - repository_id description: Pull request number for this codespace type: object properties: pull_request_number: description: Pull request number type: integer repository_id: description: Repository id for this codespace type: integer location: description: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. type: string geo: description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. type: string enum: - EuropeWest - SoutheastAsia - UsEast - UsWest machine: description: Machine type to use for this codespace type: string devcontainer_path: description: Path to devcontainer.json config to use for this codespace type: string working_directory: description: Working directory for this codespace type: string idle_timeout_minutes: description: Time in minutes before codespace stops from inactivity type: integer examples: default: value: repository_id: 1 ref: main geo: UsWest responses: '201': description: Response when the codespace was successfully created content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/user/codespaces/secrets": get: summary: List secrets for the authenticated user description: |- Lists all development environment secrets available for a user's codespaces without revealing their encrypted values. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-secrets-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-secrets-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - secrets properties: total_count: type: integer secrets: type: array items: "$ref": "#/components/schemas/codespaces-secret" examples: default: "$ref": "#/components/examples/repo-codespaces-secret-paginated" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets "/user/codespaces/secrets/public-key": get: summary: Get public key for the authenticated user description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-public-key-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespaces-user-public-key" examples: default: "$ref": "#/components/examples/codespaces-user-public-key" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets "/user/codespaces/secrets/{secret_name}": get: summary: Get a secret for the authenticated user description: |- Gets a development environment secret available to a user's codespaces without revealing its encrypted value. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-secret-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespaces-secret" examples: default: "$ref": "#/components/examples/user-codespaces-secret" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets put: summary: Create or update a secret for the authenticated user description: |- Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-secret-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: encrypted_value: type: string description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" key_id: type: string description: ID of the key you used to encrypt the secret. selected_repository_ids: type: array description: An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. items: anyOf: - type: integer - type: string required: - key_id examples: default: value: encrypted_value: c2VjcmV0 key_id: '012345678912345678' selected_repository_ids: - '1234567' - '2345678' responses: '201': description: Response after successfully creating a secret content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response after successfully updating a secret '422': "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets delete: summary: Delete a secret for the authenticated user description: |- Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-secret-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/secret-name" responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets "/user/codespaces/secrets/{secret_name}/repositories": get: summary: List selected repositories for a user secret description: |- List the repositories that have been granted the ability to use a user's development environment secret. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-repositories-for-secret-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - "$ref": "#/components/parameters/secret-name" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repositories: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-paginated" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets put: summary: Set selected repositories for a user secret description: |- Select the repositories that will use a user's development environment secret. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-repositories-for-secret-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - "$ref": "#/components/parameters/secret-name" requestBody: required: true content: application/json: schema: type: object properties: selected_repository_ids: type: array description: An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. items: type: integer required: - selected_repository_ids examples: default: value: selected_repository_ids: - '1296269' - '1296280' responses: '204': description: No Content when repositories were added to the selected list '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add a selected repository to a user secret description: |- Adds a repository to the selected repositories for a user's development environment secret. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-repository-for-secret-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: No Content when repository was added to the selected list '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets delete: summary: Remove a selected repository from a user secret description: |- Removes a repository from the selected repositories for a user's development environment secret. The authenticated user must have Codespaces access to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/remove-repository-for-secret-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - "$ref": "#/components/parameters/secret-name" - name: repository_id in: path required: true schema: type: integer responses: '204': description: No Content when repository was removed from the selected list '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: secrets "/user/codespaces/{codespace_name}": get: summary: Get a codespace for the authenticated user description: |- Gets information about a user's codespace. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/codespace-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces patch: summary: Update a codespace for the authenticated user description: |- Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. If you specify a new machine type it will be applied the next time your codespace is started. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/update-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/codespace-name" requestBody: required: false content: application/json: schema: type: object properties: machine: description: A valid machine to transition this codespace to. type: string display_name: description: Display name for this codespace type: string recent_folders: description: Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. type: array items: type: string examples: default: value: machine: standardLinux responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces delete: summary: Delete a codespace for the authenticated user description: |- Deletes a user's codespace. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/codespace-name" responses: '202': "$ref": "#/components/responses/accepted" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/user/codespaces/{codespace_name}/exports": post: summary: Export a codespace for the authenticated user description: |- Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/export-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/codespace-name" responses: '202': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace-export-details" examples: default: "$ref": "#/components/examples/user-export-details" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/user/codespaces/{codespace_name}/exports/{export_id}": get: summary: Get details about a codespace export description: |- Gets information about an export of a codespace. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-export-details-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - "$ref": "#/components/parameters/codespace-name" - "$ref": "#/components/parameters/export-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace-export-details" examples: default: "$ref": "#/components/examples/user-export-details" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/user/codespaces/{codespace_name}/machines": get: summary: List machine types for a codespace description: |- List the machine types a codespace can transition to use. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/codespace-machines-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - "$ref": "#/components/parameters/codespace-name" responses: '200': description: Response content: application/json: schema: type: object required: - total_count - machines properties: total_count: type: integer machines: type: array items: "$ref": "#/components/schemas/codespace-machine" examples: default: "$ref": "#/components/examples/codespace-machines-list" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: machines "/user/codespaces/{codespace_name}/publish": post: summary: Create a repository from an unpublished codespace description: |- Publishes an unpublished codespace, creating a new repository and assigning it to the codespace. The codespace's token is granted write permissions to the repository, allowing the user to push their changes. This will fail for a codespace that is already published, meaning it has an associated repository. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/publish-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - "$ref": "#/components/parameters/codespace-name" requestBody: required: true content: application/json: schema: type: object properties: name: description: A name for the new repository. type: string private: description: Whether the new repository should be private. type: boolean default: false examples: default: value: repository: monalisa-octocat-hello-world-g4wpq6h95q private: false responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace-with-full-repository" examples: default: "$ref": "#/components/examples/codespace-with-full-repository" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false category: codespaces subcategory: codespaces "/user/codespaces/{codespace_name}/start": post: summary: Start a codespace for the authenticated user description: |- Starts a user's codespace. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/start-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/codespace-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '304': "$ref": "#/components/responses/not_modified" '500': "$ref": "#/components/responses/internal_error" '400': "$ref": "#/components/responses/bad_request" '401': "$ref": "#/components/responses/requires_authentication" '402': description: Payment required content: application/json: schema: "$ref": "#/components/schemas/basic-error" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/user/codespaces/{codespace_name}/stop": post: summary: Stop a codespace for the authenticated user description: |- Stops a user's codespace. OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/stop-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/codespace-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/codespace" examples: default: "$ref": "#/components/examples/codespace" '500': "$ref": "#/components/responses/internal_error" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: codespaces subcategory: codespaces "/user/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for authenticated-user description: |- Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/packages-for-user" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/user/email/visibility": patch: summary: Set primary email visibility for the authenticated user description: Sets the visibility for your primary email addresses. tags: - users operationId: users/set-primary-email-visibility-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user parameters: [] requestBody: required: true content: application/json: schema: properties: visibility: description: Denotes whether an email is publicly visible. type: string enum: - public - private required: - visibility type: object examples: default: summary: Example setting the primary email address to private value: visibility: private responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/email" examples: default: "$ref": "#/components/examples/email-items-3" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: emails "/user/emails": get: summary: List email addresses for the authenticated user description: |- Lists all of your email addresses, and specifies which one is visible to the public. OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. tags: - users operationId: users/list-emails-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-email-addresses-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/email" examples: default: "$ref": "#/components/examples/email-items-2" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: emails post: summary: Add an email address for the authenticated user description: OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/add-email-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#add-an-email-address-for-the-authenticated-user parameters: [] requestBody: required: false content: application/json: schema: oneOf: - type: object properties: emails: description: Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. type: array items: type: string example: username@example.com minItems: 1 example: [] required: - emails example: emails: - octocat@github.com - mona@github.com - type: array items: type: string example: username@example.com minItems: 1 - type: string examples: default: summary: Example adding multiple email addresses value: emails: - octocat@github.com - mona@github.com - octocat@octocat.org responses: '201': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/email" examples: default: "$ref": "#/components/examples/email-items" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: emails delete: summary: Delete an email address for the authenticated user description: OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/delete-email-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#delete-an-email-address-for-the-authenticated-user parameters: [] requestBody: content: application/json: schema: oneOf: - type: object description: Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. properties: emails: description: Email addresses associated with the GitHub user account. type: array items: type: string example: username@example.com minItems: 1 example: emails: - octocat@github.com - mona@github.com required: - emails - type: array items: type: string example: username@example.com minItems: 1 - type: string examples: default: summary: Example deleting multiple email accounts value: emails: - octocat@github.com - mona@github.com responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: emails "/user/followers": get: summary: List followers of the authenticated user description: Lists the people following the authenticated user. tags: - users operationId: users/list-followers-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers "/user/following": get: summary: List the people the authenticated user follows description: Lists the people who the authenticated user follows. tags: - users operationId: users/list-followed-by-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-the-authenticated-user-follows parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers "/user/following/{username}": get: summary: Check if a person is followed by the authenticated user description: '' tags: - users operationId: users/check-person-is-followed-by-authenticated externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/username" responses: '204': description: if the person is followed by the authenticated user '404': description: if the person is not followed by the authenticated user content: application/json: schema: "$ref": "#/components/schemas/basic-error" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers put: summary: Follow a user description: |- Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. tags: - users operationId: users/follow externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - "$ref": "#/components/parameters/username" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers delete: summary: Unfollow a user description: OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. tags: - users operationId: users/unfollow externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - "$ref": "#/components/parameters/username" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers "/user/gpg_keys": get: summary: List GPG keys for the authenticated user description: |- Lists the current user's GPG keys. OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. tags: - users operationId: users/list-gpg-keys-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/gpg-key" examples: default: "$ref": "#/components/examples/gpg-key-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: gpg-keys post: summary: Create a GPG key for the authenticated user description: |- Adds a GPG key to the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. operationId: users/create-gpg-key-for-authenticated-user tags: - users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user parameters: [] requestBody: required: true content: application/json: schema: properties: name: description: A descriptive name for the new key. type: string armored_public_key: description: A GPG key in ASCII-armored format. type: string type: object required: - armored_public_key examples: default: value: name: Octocat's GPG Key armored_public_key: |- -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1 mQINBFnZ2ZIBEADQ2Z7Z7 -----END PGP PUBLIC KEY BLOCK----- responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/gpg-key" examples: default: "$ref": "#/components/examples/gpg-key" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: gpg-keys "/user/gpg_keys/{gpg_key_id}": get: summary: Get a GPG key for the authenticated user description: |- View extended details for a single GPG key. OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. tags: - users operationId: users/get-gpg-key-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/gpg-key-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/gpg-key" examples: default: "$ref": "#/components/examples/gpg-key" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: gpg-keys delete: summary: Delete a GPG key for the authenticated user description: |- Removes a GPG key from the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. tags: - users operationId: users/delete-gpg-key-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/gpg-key-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: gpg-keys "/user/installations": get: summary: List app installations accessible to the user access token description: |- Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. You can find the permissions for the installation under the `permissions` key. tags: - apps operationId: apps/list-installations-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-app-installations-accessible-to-the-user-access-token parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: You can find the permissions for the installation under the `permissions` key. content: application/json: schema: type: object required: - total_count - installations properties: total_count: type: integer installations: type: array items: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/base-installation-for-auth-user-paginated" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: installations "/user/installations/{installation_id}/repositories": get: summary: List repositories accessible to the user access token description: |- List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. The access the user has to each repository is included in the hash under the `permissions` key. tags: - apps operationId: apps/list-installation-repos-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#list-repositories-accessible-to-the-user-access-token parameters: - "$ref": "#/components/parameters/installation-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: The access the user has to each repository is included in the hash under the `permissions` key. content: application/json: schema: type: object required: - total_count - repositories properties: total_count: type: integer repository_selection: type: string repositories: type: array items: "$ref": "#/components/schemas/repository" examples: default: "$ref": "#/components/examples/repository-paginated" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: installations "/user/installations/{installation_id}/repositories/{repository_id}": put: summary: Add a repository to an app installation description: "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope." tags: - apps operationId: apps/add-repo-to-installation-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - "$ref": "#/components/parameters/installation-id" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: installations delete: summary: Remove a repository from an app installation description: "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope." tags: - apps operationId: apps/remove-repo-from-installation-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - "$ref": "#/components/parameters/installation-id" - "$ref": "#/components/parameters/repository-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '422': description: Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: installations "/user/interaction-limits": get: summary: Get interaction restrictions for your public repositories description: Shows which type of GitHub user can interact with your public repositories and when the restriction expires. tags: - interactions operationId: interactions/get-restrictions-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#get-interaction-restrictions-for-your-public-repositories responses: '200': description: Default response content: application/json: schema: anyOf: - "$ref": "#/components/schemas/interaction-limit-response" - type: object properties: {} additionalProperties: false examples: default: "$ref": "#/components/examples/interaction-limit-response" '204': description: Response when there are no restrictions x-github: githubCloudOnly: false enabledForGitHubApps: false category: interactions subcategory: user put: summary: Set interaction restrictions for your public repositories description: Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. tags: - interactions operationId: interactions/set-restrictions-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#set-interaction-restrictions-for-your-public-repositories requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/interaction-limit" examples: default: value: limit: collaborators_only expiry: one_month responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/interaction-limit-response" examples: default: "$ref": "#/components/examples/interaction-limit-user" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: interactions subcategory: user delete: summary: Remove interaction restrictions from your public repositories description: Removes any interaction restrictions from your public repositories. tags: - interactions operationId: interactions/remove-restrictions-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: interactions subcategory: user "/user/issues": get: summary: List user account issues assigned to the authenticated user description: |- List issues across owned and member repositories assigned to the authenticated user. > [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues operationId: issues/list-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - "$ref": "#/components/parameters/labels" - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/issue" examples: default: "$ref": "#/components/examples/issue-with-repo-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues "/user/keys": get: summary: List public SSH keys for the authenticated user description: |- Lists the public SSH keys for the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. tags: - users operationId: users/list-public-ssh-keys-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-ssh-keys-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/key" examples: default: "$ref": "#/components/examples/key-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: keys post: summary: Create a public SSH key for the authenticated user description: |- Adds a public SSH key to the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. operationId: users/create-public-ssh-key-for-authenticated-user tags: - users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user parameters: [] requestBody: required: true content: application/json: schema: properties: title: description: A descriptive name for the new key. type: string example: Personal MacBook Air key: description: The public SSH key to add to your GitHub account. type: string pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " required: - key type: object examples: default: value: title: ssh-rsa AAAAB3NzaC1yc2EAAA key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/key" examples: default: "$ref": "#/components/examples/key" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: keys "/user/keys/{key_id}": get: summary: Get a public SSH key for the authenticated user description: |- View extended details for a single public SSH key. OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. tags: - users operationId: users/get-public-ssh-key-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/key-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/key" examples: default: "$ref": "#/components/examples/key" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: keys delete: summary: Delete a public SSH key for the authenticated user description: |- Removes a public SSH key from the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. tags: - users operationId: users/delete-public-ssh-key-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/key-id" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: keys "/user/marketplace_purchases": get: summary: List subscriptions for the authenticated user description: Lists the active subscriptions for the authenticated user. tags: - apps operationId: apps/list-subscriptions-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/user-marketplace-purchase" examples: default: "$ref": "#/components/examples/user-marketplace-purchase-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '401': "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/user/marketplace_purchases/stubbed": get: summary: List subscriptions for the authenticated user (stubbed) description: Lists the active subscriptions for the authenticated user. tags: - apps operationId: apps/list-subscriptions-for-authenticated-user-stubbed externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/user-marketplace-purchase" examples: default: "$ref": "#/components/examples/user-marketplace-purchase-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: marketplace "/user/memberships/orgs": get: summary: List organization memberships for the authenticated user description: Lists all of the authenticated user's organization memberships. tags: - orgs operationId: orgs/list-memberships-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-memberships-for-the-authenticated-user parameters: - name: state description: Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. in: query required: false schema: type: string enum: - active - pending - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/org-membership" examples: default: "$ref": "#/components/examples/org-membership-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/user/memberships/orgs/{org}": get: summary: Get an organization membership for the authenticated user description: If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. tags: - orgs operationId: orgs/get-membership-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/org" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/org-membership" examples: default: "$ref": "#/components/examples/org-membership" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members patch: summary: Update an organization membership for the authenticated user description: Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. tags: - orgs operationId: orgs/update-membership-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/org" requestBody: required: true content: application/json: schema: type: object properties: state: type: string description: The state that the membership should be in. Only `"active"` will be accepted. enum: - active required: - state examples: default: value: state: active responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/org-membership" examples: default: "$ref": "#/components/examples/org-membership-2" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members "/user/migrations": get: summary: List user migrations description: Lists all migrations a user has started. tags: - migrations operationId: migrations/list-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/migration" examples: default: "$ref": "#/components/examples/migration-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: users post: summary: Start a user migration description: Initiates the generation of a user migration archive. tags: - migrations operationId: migrations/start-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration parameters: [] requestBody: required: true content: application/json: schema: properties: lock_repositories: description: Lock the repositories being migrated at the start of the migration example: true readOnly: false type: boolean exclude_metadata: description: Indicates whether metadata should be excluded and only git source should be included for the migration. example: true readOnly: false type: boolean exclude_git_data: description: Indicates whether the repository git data should be excluded from the migration. example: true readOnly: false type: boolean exclude_attachments: description: Do not include attachments in the migration example: true readOnly: false type: boolean exclude_releases: description: Do not include releases in the migration example: true readOnly: false type: boolean exclude_owner_projects: description: Indicates whether projects owned by the organization or users should be excluded. example: true readOnly: false type: boolean org_metadata_only: type: boolean example: true description: Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). default: false exclude: description: Exclude attributes from the API response to improve performance example: - repositories readOnly: false type: array items: description: Allowed values that can be passed to the exclude param. enum: - repositories example: repositories type: string repositories: type: array items: description: Repository path, owner and name example: acme/widgets type: string required: - repositories type: object examples: default: value: repositories: - octocat/Hello-World lock_repositories: true responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/migration" examples: default: "$ref": "#/components/examples/migration-2" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: users "/user/migrations/{migration_id}": get: summary: Get a user migration status description: |- Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * `pending` - the migration hasn't started yet. * `exporting` - the migration is in progress. * `exported` - the migration finished successfully. * `failed` - the migration failed. Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive). tags: - migrations operationId: migrations/get-status-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - "$ref": "#/components/parameters/migration-id" - name: exclude in: query required: false schema: type: array items: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/migration" examples: default: "$ref": "#/components/examples/migration" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: users "/user/migrations/{migration_id}/archive": get: summary: Download a user migration archive description: |- Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * attachments * bases * commit\_comments * issue\_comments * issue\_events * issues * milestones * organizations * projects * protected\_branches * pull\_request\_reviews * pull\_requests * releases * repositories * review\_comments * schema * users The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. tags: - migrations operationId: migrations/get-archive-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - "$ref": "#/components/parameters/migration-id" responses: '302': description: Response '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: users delete: summary: Delete a user migration archive description: Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. tags: - migrations operationId: migrations/delete-archive-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - "$ref": "#/components/parameters/migration-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: users "/user/migrations/{migration_id}/repos/{repo_name}/lock": delete: summary: Unlock a user repository description: Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. tags: - migrations operationId: migrations/unlock-repo-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - "$ref": "#/components/parameters/migration-id" - "$ref": "#/components/parameters/repo-name" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: users "/user/migrations/{migration_id}/repositories": get: summary: List repositories for a user migration description: Lists all the repositories for this user migration. tags: - migrations operationId: migrations/list-repos-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - "$ref": "#/components/parameters/migration-id" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: migrations subcategory: users "/user/orgs": get: summary: List organizations for the authenticated user description: |- List organizations for the authenticated user. For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. > [!NOTE] > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. tags: - orgs operationId: orgs/list-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-simple" examples: default: "$ref": "#/components/examples/organization-simple-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: orgs subcategory: orgs "/user/packages": get: summary: List packages for the authenticated user's namespace description: |- Lists packages owned by the authenticated user within the user's namespace. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-the-authenticated-users-namespace parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. in: query required: true schema: type: string enum: - npm - maven - rubygems - docker - nuget - container - "$ref": "#/components/parameters/package-visibility" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/packages-for-user" '400': "$ref": "#/components/responses/package_es_list_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/user/packages/{package_type}/{package_name}": get: summary: Get a package for the authenticated user description: |- Gets a specific package for a package owned by the authenticated user. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/package-user" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages delete: summary: Delete a package for the authenticated user description: |- Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/user/packages/{package_type}/{package_name}/restore": post: summary: Restore a package for the authenticated user description: |- Restores a package owned by the authenticated user. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - name: token description: package token schema: type: string required: false in: query responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/user/packages/{package_type}/{package_name}/versions": get: summary: List package versions for a package owned by the authenticated user description: |- Lists package versions for a package owned by the authenticated user. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" - name: state in: query required: false description: The state of the package, either active or deleted. schema: type: string enum: - active - deleted default: active responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package-version" examples: default: "$ref": "#/components/examples/package-versions-for-authenticated-user" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": get: summary: Get a package version for the authenticated user description: |- Gets a specific package version for a package owned by the authenticated user. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/package-version-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/package-version" examples: default: "$ref": "#/components/examples/package-version-authenticated-user" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages delete: summary: Delete a package version for the authenticated user description: |- Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. The authenticated user must have admin permissions in the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/package-version-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": post: summary: Restore a package version for the authenticated user description: |- Restores a package version owned by the authenticated user. You can restore a deleted package version under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/package-version-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/user/public_emails": get: summary: List public email addresses for the authenticated user description: |- Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. tags: - users operationId: users/list-public-emails-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/emails#list-public-email-addresses-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/email" examples: default: "$ref": "#/components/examples/email-items-2" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: emails "/user/repos": get: summary: List repositories for the authenticated user description: |- Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. tags: - repos operationId: repos/list-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-the-authenticated-user parameters: - name: visibility description: Limit results to repositories with the specified visibility. in: query required: false schema: type: string enum: - all - public - private default: all - name: affiliation description: "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on." in: query required: false schema: type: string default: owner,collaborator,organization_member - name: type description: Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. in: query required: false schema: type: string enum: - all - owner - public - private - member default: all - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated - pushed - full_name default: full_name - name: direction description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.' in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/since-repo-date" - "$ref": "#/components/parameters/before-repo-date" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository" examples: default: "$ref": "#/components/examples/repository-items-default-response" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: repos subcategory: repos post: summary: Create a repository for the authenticated user description: |- Creates a new repository for the authenticated user. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user parameters: [] requestBody: required: true content: application/json: schema: properties: name: description: The name of the repository. type: string example: Team Environment description: description: A short description of the repository. type: string homepage: description: A URL with more information about the repository. type: string private: description: Whether the repository is private. default: false type: boolean has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true team_id: description: The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. type: integer auto_init: description: Whether the repository is initialized with a minimal README. default: false type: boolean gitignore_template: description: The desired language or platform to apply to the .gitignore. example: Haskell type: string license_template: description: The license keyword of the open source license for this repository. example: mit type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- Required when using `squash_merge_commit_message`. The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- Required when using `merge_commit_message`. The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true required: - name type: object examples: default: value: name: Hello-World description: This is your first repo! homepage: https://github.com private: false is_template: true responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/full-repository" examples: default: "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World schema: type: string '401': "$ref": "#/components/responses/requires_authentication" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '422': "$ref": "#/components/responses/validation_failed" '400': "$ref": "#/components/responses/bad_request" x-github: githubCloudOnly: false enabledForGitHubApps: false category: repos subcategory: repos "/user/repository_invitations": get: summary: List repository invitations for the authenticated user description: When authenticating as a user, this endpoint will list all currently open repository invitations for that user. tags: - repos operationId: repos/list-invitations-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository-invitation" examples: default: "$ref": "#/components/examples/repository-invitation-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: collaborators subcategory: invitations "/user/repository_invitations/{invitation_id}": patch: summary: Accept a repository invitation description: '' tags: - repos operationId: repos/accept-invitation-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - "$ref": "#/components/parameters/invitation-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '409': "$ref": "#/components/responses/conflict" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: false category: collaborators subcategory: invitations delete: summary: Decline a repository invitation description: '' tags: - repos operationId: repos/decline-invitation-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - "$ref": "#/components/parameters/invitation-id" responses: '204': description: Response '409': "$ref": "#/components/responses/conflict" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: collaborators subcategory: invitations "/user/social_accounts": get: summary: List social accounts for the authenticated user description: Lists all of your social accounts. tags: - users operationId: users/list-social-accounts-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/social-account" examples: default: "$ref": "#/components/examples/social-account-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: social-accounts post: summary: Add social accounts for the authenticated user description: |- Add one or more social accounts to the authenticated user's profile. OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/add-social-account-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#add-social-accounts-for-the-authenticated-user parameters: [] requestBody: required: true content: application/json: schema: type: object properties: account_urls: description: Full URLs for the social media profiles to add. type: array items: type: string example: https://twitter.com/github example: [] required: - account_urls example: account_urls: - https://www.linkedin.com/company/github/ - https://twitter.com/github examples: default: summary: Adding multiple social accounts value: account_urls: - https://facebook.com/GitHub - https://www.youtube.com/@GitHub responses: '201': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/social-account" examples: default: "$ref": "#/components/examples/social-account-items" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: social-accounts delete: summary: Delete social accounts for the authenticated user description: |- Deletes one or more social accounts from the authenticated user's profile. OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/delete-social-account-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user parameters: [] requestBody: required: true content: application/json: schema: type: object properties: account_urls: description: Full URLs for the social media profiles to delete. type: array items: type: string example: https://twitter.com/github example: [] required: - account_urls example: account_urls: - https://www.linkedin.com/company/github/ - https://twitter.com/github examples: default: summary: Deleting multiple social accounts value: account_urls: - https://facebook.com/GitHub - https://www.youtube.com/@GitHub responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: social-accounts "/user/ssh_signing_keys": get: summary: List SSH signing keys for the authenticated user description: |- Lists the SSH signing keys for the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/list-ssh-signing-keys-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/ssh-signing-key" examples: default: "$ref": "#/components/examples/ssh-signing-key-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false previews: [] category: users subcategory: ssh-signing-keys post: summary: Create a SSH signing key for the authenticated user description: |- Creates an SSH signing key for the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. operationId: users/create-ssh-signing-key-for-authenticated-user tags: - users externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user parameters: [] requestBody: required: true content: application/json: schema: properties: title: description: A descriptive name for the new key. type: string example: Personal MacBook Air key: description: The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-cloud@latest//authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." type: string pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " required: - key type: object examples: default: value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 title: ssh-rsa AAAAB3NzaC1yc2EAAA responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/ssh-signing-key" examples: default: "$ref": "#/components/examples/ssh-signing-key" '422': "$ref": "#/components/responses/validation_failed" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: ssh-signing-keys "/user/ssh_signing_keys/{ssh_signing_key_id}": get: summary: Get an SSH signing key for the authenticated user description: |- Gets extended details for an SSH signing key. OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/get-ssh-signing-key-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/ssh-signing-key-id" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/ssh-signing-key" examples: default: "$ref": "#/components/examples/ssh-signing-key" '404': "$ref": "#/components/responses/not_found" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: ssh-signing-keys delete: summary: Delete an SSH signing key for the authenticated user description: |- Deletes an SSH signing key from the authenticated user's GitHub account. OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/delete-ssh-signing-key-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/ssh-signing-key-id" responses: '204': description: Response '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: ssh-signing-keys "/user/starred": get: summary: List repositories starred by the authenticated user description: |- Lists repositories the authenticated user has starred. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-repos-starred-by-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/sort-starred" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/repository" examples: default-response: "$ref": "#/components/examples/repository-items-default-response" application/vnd.github.v3.star+json: schema: type: array items: "$ref": "#/components/schemas/starred-repository" examples: alternative-response-with-star-creation-timestamps: "$ref": "#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring "/user/starred/{owner}/{repo}": get: summary: Check if a repository is starred by the authenticated user description: Whether the authenticated user has starred the repository. tags: - activity operationId: activity/check-repo-is-starred-by-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response if this repository is starred by you '404': description: Not Found if this repository is not starred by you content: application/json: schema: "$ref": "#/components/schemas/basic-error" '401': "$ref": "#/components/responses/requires_authentication" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring put: summary: Star a repository for the authenticated user description: Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." tags: - activity operationId: activity/star-repo-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '401': "$ref": "#/components/responses/requires_authentication" '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring delete: summary: Unstar a repository for the authenticated user description: Unstar a repository that the authenticated user has previously starred. tags: - activity operationId: activity/unstar-repo-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '401': "$ref": "#/components/responses/requires_authentication" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring "/user/subscriptions": get: summary: List repositories watched by the authenticated user description: Lists repositories the authenticated user is watching. tags: - activity operationId: activity/list-watched-repos-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: watching "/user/teams": get: summary: List teams for the authenticated user description: |- List all of the teams across all of the organizations to which the authenticated user belongs. OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. tags: - teams operationId: teams/list-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/team-full" examples: default: "$ref": "#/components/examples/team-full-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" x-github: githubCloudOnly: false enabledForGitHubApps: false category: teams subcategory: teams "/user/{account_id}": get: summary: Get a user using their ID description: |- Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails). tags: - users operationId: users/get-by-id externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - "$ref": "#/components/parameters/account-id" responses: '200': description: Response content: application/json: schema: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" discriminator: propertyName: user_view_type mapping: public: "#/components/schemas/public-user" private: "#/components/schemas/private-user" examples: default-response: "$ref": "#/components/examples/public-user-default-response" response-with-git-hub-plan-information: "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: users "/user/{user_id}/projectsV2/{project_number}/drafts": post: summary: Create draft item for user owned project description: Create draft issue item for the specified user owned project. tags: - projects operationId: projects/create-draft-item-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - "$ref": "#/components/parameters/user-id" - "$ref": "#/components/parameters/project-number" requestBody: required: true description: Details of the draft item to create in the project. content: application/json: schema: type: object properties: title: type: string description: The title of the draft issue item to create in the project. body: type: string description: The body content of the draft issue item to create in the project. required: - title examples: title: summary: Example with Sample Draft Issue Title value: title: Sample Draft Issue Title body: summary: Example with Sample Draft Issue Title and Body value: title: Sample Draft Issue Title body: This is the body content of the draft issue. responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: draft_issue: "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: drafts "/users": get: summary: List users description: |- Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts. Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. tags: - users operationId: users/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - "$ref": "#/components/parameters/since-user" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: example: ; rel="next" schema: type: string '304': "$ref": "#/components/responses/not_modified" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: users "/users/{username}": get: summary: Get a user description: |- Provides publicly available information about someone with a GitHub account. If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails). tags: - users operationId: users/get-by-username externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: oneOf: - "$ref": "#/components/schemas/private-user" - "$ref": "#/components/schemas/public-user" discriminator: propertyName: user_view_type mapping: public: "#/components/schemas/public-user" private: "#/components/schemas/private-user" examples: default-response: "$ref": "#/components/examples/public-user-default-response" response-with-git-hub-plan-information: "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: users "/users/{username}/attestations/bulk-list": post: summary: List attestations by bulk subject digests description: |- List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. 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 `attestations:read` permission is required. **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - users operationId: users/list-attestations-bulk externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/username" requestBody: required: true content: application/json: schema: type: object properties: subject_digests: type: array items: type: string description: List of subject digests to fetch attestations for. minItems: 1 maxItems: 1024 predicate_type: type: string description: |- Optional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types. required: - subject_digests examples: default: "$ref": "#/components/examples/bulk-subject-digest-body" withPredicateType: "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" responses: '200': description: Response content: application/json: schema: type: object properties: attestations_subject_digests: type: object additionalProperties: nullable: true type: array items: type: object properties: bundle: type: object properties: mediaType: type: string verificationMaterial: type: object properties: {} additionalProperties: true dsseEnvelope: type: object properties: {} additionalProperties: true description: The bundle of the attestation. repository_id: type: integer bundle_url: type: string description: Mapping of subject digest to bundles. page_info: type: object properties: has_next: type: boolean description: Indicates whether there is a next page. has_previous: type: boolean description: Indicates whether there is a previous page. next: type: string description: The cursor to the next page. previous: type: string description: The cursor to the previous page. description: Information about the current page. examples: default: "$ref": "#/components/examples/list-attestations-bulk" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: attestations "/users/{username}/attestations/delete-request": post: summary: Delete attestations in bulk description: Delete artifact attestations in bulk by either subject digests or unique ID. tags: - users operationId: users/delete-attestations-bulk externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - "$ref": "#/components/parameters/username" requestBody: required: true content: application/json: schema: type: object oneOf: - properties: subject_digests: type: array items: type: string description: List of subject digests associated with the artifact attestations to delete. minItems: 1 maxItems: 1024 required: - subject_digests - properties: attestation_ids: type: array items: type: integer description: List of unique IDs associated with the artifact attestations to delete. minItems: 1 maxItems: 1024 required: - attestation_ids description: The request body must include either `subject_digests` or `attestation_ids`, but not both. examples: by-subject-digests: summary: Delete by subject digests value: subject_digests: - sha256:abc123 - sha512:def456 by-attestation-ids: summary: Delete by attestation IDs value: attestation_ids: - 111 - 222 responses: '200': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: attestations "/users/{username}/attestations/digest/{subject_digest}": delete: summary: Delete attestations by subject digest description: Delete an artifact attestation by subject digest. tags: - users operationId: users/delete-attestations-by-subject-digest externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - "$ref": "#/components/parameters/username" - name: subject_digest description: Subject Digest in: path required: true schema: type: string x-multi-segment: true responses: '200': description: Response '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: attestations "/users/{username}/attestations/{attestation_id}": delete: summary: Delete attestations by ID description: Delete an artifact attestation by unique ID that is associated with a repository owned by a user. tags: - users operationId: users/delete-attestations-by-id externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - "$ref": "#/components/parameters/username" - name: attestation_id description: Attestation ID in: path required: true schema: type: integer responses: '200': description: Response '204': description: Response '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: attestations "/users/{username}/attestations/{subject_digest}": get: summary: List attestations description: |- List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. 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 `attestations:read` permission is required. **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - users operationId: users/list-attestations externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/username" - name: subject_digest description: Subject Digest in: path required: true schema: type: string x-multi-segment: true - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: type: object properties: attestations: type: array items: type: object properties: bundle: type: object properties: mediaType: type: string verificationMaterial: type: object properties: {} additionalProperties: true dsseEnvelope: type: object properties: {} additionalProperties: true description: |- The attestation's Sigstore Bundle. Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer bundle_url: type: string initiator: type: string examples: default: "$ref": "#/components/examples/list-attestations" '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/empty-object" examples: default: value: '204': description: Response '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: attestations "/users/{username}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for user description: |- Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/packages-for-user" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/users/{username}/events": get: summary: List events for the authenticated user description: |- If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: default: "$ref": "#/components/examples/user-events-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user description: |- This is the user's organization dashboard. You must be authenticated as the user to view this. > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: default: "$ref": "#/components/examples/user-org-events-items" x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: events "/users/{username}/events/public": get: summary: List public events for a user description: |- > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: default: "$ref": "#/components/examples/user-public-events-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/users/{username}/followers": get: summary: List followers of a user description: Lists the people following the specified user. tags: - users operationId: users/list-followers-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: followers "/users/{username}/following": get: summary: List the people a user follows description: Lists the people who the specified user follows. tags: - users operationId: users/list-following-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/simple-user" examples: default: "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: followers "/users/{username}/following/{target_user}": get: summary: Check if a user follows another user description: '' tags: - users operationId: users/check-following-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - "$ref": "#/components/parameters/username" - name: target_user in: path required: true schema: type: string responses: '204': description: if the user follows the target user '404': description: if the user does not follow the target user x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: followers "/users/{username}/gists": get: summary: List gists for a user description: 'Lists public gists for the specified user:' tags: - gists operationId: gists/list-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/base-gist" examples: default: "$ref": "#/components/examples/base-gist-items" headers: Link: "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: gists subcategory: gists "/users/{username}/gpg_keys": get: summary: List GPG keys for a user description: Lists the GPG keys for a user. This information is accessible by anyone. tags: - users operationId: users/list-gpg-keys-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/gpg-key" examples: default: "$ref": "#/components/examples/gpg-key-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: gpg-keys "/users/{username}/hovercard": get: summary: Get contextual information for a user description: |- Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - users operationId: users/get-context-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - "$ref": "#/components/parameters/username" - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. in: query required: false schema: type: string enum: - organization - repository - issue - pull_request - name: subject_id description: Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. in: query required: false schema: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/hovercard" examples: default: "$ref": "#/components/examples/hovercard" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: users "/users/{username}/installation": get: summary: Get a user installation for the authenticated app description: |- Enables an authenticated GitHub App to find the user’s installation information. You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps operationId: apps/get-user-installation externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/installation" examples: default: "$ref": "#/components/examples/installation" x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps "/users/{username}/keys": get: summary: List public keys for a user description: Lists the _verified_ public SSH keys for a user. This is accessible by anyone. tags: - users operationId: users/list-public-keys-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/key-simple" examples: default: "$ref": "#/components/examples/key-simple-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: keys "/users/{username}/orgs": get: summary: List organizations for a user description: |- List [public organization memberships](https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership) for the specified user. This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. tags: - orgs operationId: orgs/list-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/organization-simple" examples: default: "$ref": "#/components/examples/organization-simple-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: orgs "/users/{username}/packages": get: summary: List packages for a user description: |- Lists all packages in a user's namespace for which the requesting user has access. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-packages-for-a-user parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. in: query required: true schema: type: string enum: - npm - maven - rubygems - docker - nuget - container - "$ref": "#/components/parameters/package-visibility" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/packages-for-user" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" '400': "$ref": "#/components/responses/package_es_list_error" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/users/{username}/packages/{package_type}/{package_name}": get: summary: Get a package for a user description: |- Gets a specific package metadata for a public package owned by a user. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/package" examples: default: "$ref": "#/components/examples/package-user" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages delete: summary: Delete a package for a user description: |- Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/username" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/users/{username}/packages/{package_type}/{package_name}/restore": post: summary: Restore a package for a user description: |- Restores an entire package for a user. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/username" - name: token description: package token schema: type: string required: false in: query responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/users/{username}/packages/{package_type}/{package_name}/versions": get: summary: List package versions for a package owned by a user description: |- Lists package versions for a public package owned by a specified user. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/package-version" examples: default: "$ref": "#/components/examples/package-versions-for-user" '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": get: summary: Get a package version for a user description: |- Gets a specific package version for a public package owned by a specified user. OAuth 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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/package-version-id" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/package-version" examples: default: "$ref": "#/components/examples/package-version-user" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages delete: summary: Delete package version for a user description: |- Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/package-version-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": post: summary: Restore package version for a user description: |- Restores a specific package version for a user. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-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](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - "$ref": "#/components/parameters/package-type" - "$ref": "#/components/parameters/package-name" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/package-version-id" responses: '204': description: Response '404': "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages "/users/{username}/projectsV2": get: summary: List projects for user description: List all projects owned by a specific user accessible by the authenticated user. tags: - projects operationId: projects/list-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user parameters: - "$ref": "#/components/parameters/username" - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/projects-v2" examples: default: "$ref": "#/components/examples/projects-v2" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: projects "/users/{username}/projectsV2/{project_number}": get: summary: Get project for user description: Get a specific user-owned project. tags: - projects operationId: projects/get-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2" examples: default: "$ref": "#/components/examples/projects-v2" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: projects "/users/{username}/projectsV2/{project_number}/fields": get: summary: List project fields for user description: List all fields for a specific user-owned project. tags: - projects operationId: projects/list-fields-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/projects-v2-field" examples: default: "$ref": "#/components/examples/projects-v2-field-items" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user description: Get a specific field for a user-owned project. tags: - projects operationId: projects/get-field-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/field-id" - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-field" examples: default: "$ref": "#/components/examples/projects-v2-field" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: fields "/users/{username}/projectsV2/{project_number}/items": get: summary: List items for a user owned project description: List all items for a specific user-owned project accessible by the authenticated user. tags: - projects operationId: projects/list-items-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. in: query required: false schema: type: string - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` in: query required: false schema: oneOf: - type: string - type: array maxItems: 50 items: type: string responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/projects-v2-item-with-content" examples: default: "$ref": "#/components/examples/projects-v2-item-with-content" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items post: summary: Add item to user owned project description: Add an issue or pull request item to the specified user owned project. tags: - projects operationId: projects/add-item-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/project-number" requestBody: required: true description: Details of the item to add to the project. content: application/json: schema: type: object properties: type: type: string enum: - Issue - PullRequest description: The type of item to add to the project. Must be either Issue or PullRequest. id: type: integer description: The numeric ID of the issue or pull request to add to the project. required: - type - id examples: issue: value: type: Issue id: 3 pull_request: value: type: PullRequest id: 3 responses: '201': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-simple" examples: issue: "$ref": "#/components/examples/projects-v2-item-simple" pull_request: "$ref": "#/components/examples/projects-v2-item-simple" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items "/users/{username}/projectsV2/{project_number}/items/{item_id}": get: summary: Get an item for a user owned project description: Get a specific item from a user-owned project. tags: - projects operationId: projects/get-user-item externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 in: query required: false schema: oneOf: - type: string - type: array maxItems: 50 items: type: string responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-with-content" examples: default: "$ref": "#/components/examples/projects-v2-item-with-content" headers: Link: "$ref": "#/components/headers/link" '304': "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items patch: summary: Update project item for user description: Update a specific item in a user-owned project. tags: - projects operationId: projects/update-item-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" requestBody: required: true description: Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. content: application/json: schema: type: object properties: fields: type: array description: A list of field updates to apply. items: type: object properties: id: type: integer description: The ID of the project field to update. value: description: |- The new value for the field: - For text, number, and date fields, provide the new value directly. - For single select and iteration fields, provide the ID of the option or iteration. - To clear the field, set this to null. nullable: true oneOf: - type: string - type: number required: - id - value required: - fields examples: text_field: summary: Update a text field value: fields: - id: 123 value: Updated text value number_field: summary: Update a number field value: fields: - id: 456 value: 42.5 date_field: summary: Update a date field value: fields: - id: 789 value: '2023-10-05' single_select_field: summary: Update a single select field value: fields: - id: 789 value: 47fc9ee4 iteration_field: summary: Update an iteration field value: fields: - id: 1011 value: 866ee5b8 responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/projects-v2-item-with-content" examples: text_field: "$ref": "#/components/examples/projects-v2-item-with-content" number_field: "$ref": "#/components/examples/projects-v2-item-with-content" date_field: "$ref": "#/components/examples/projects-v2-item-with-content" single_select_field: "$ref": "#/components/examples/projects-v2-item-with-content" iteration_field: "$ref": "#/components/examples/projects-v2-item-with-content" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items delete: summary: Delete project item for user description: Delete a specific item from a user-owned project. tags: - projects operationId: projects/delete-item-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - "$ref": "#/components/parameters/project-number" - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/item-id" responses: '204': description: Response '403': "$ref": "#/components/responses/forbidden" '401': "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: items "/users/{username}/received_events": get: summary: List events received by the authenticated user description: |- These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: default: "$ref": "#/components/examples/user-received-events-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/users/{username}/received_events/public": get: summary: List public events received by a user description: |- > [!NOTE] > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/event" examples: default: "$ref": "#/components/examples/user-received-public-events-items" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events "/users/{username}/repos": get: summary: List repositories for a user description: Lists public repositories for the specified user. tags: - repos operationId: repos/list-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - "$ref": "#/components/parameters/username" - name: type description: Limit results to repositories of the specified type. in: query required: false schema: type: string enum: - all - owner - member default: owner - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated - pushed - full_name default: full_name - name: direction description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.' in: query required: false schema: type: string enum: - asc - desc - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos "/users/{username}/settings/billing/actions": get: summary: Get GitHub Actions billing for a user description: |- Gets the summary of the free and paid GitHub Actions minutes used. Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-github-actions-billing-user tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/actions-billing-usage" examples: default: "$ref": "#/components/examples/actions-billing-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: billing subcategory: billing "/users/{username}/settings/billing/packages": get: summary: Get GitHub Packages billing for a user description: |- Gets the free and paid storage used for GitHub Packages in gigabytes. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-github-packages-billing-user tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/packages-billing-usage" examples: default: "$ref": "#/components/examples/packages-billing-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: billing subcategory: billing "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user description: |- Gets a report of premium request usage for a user. **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month-default" - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-model" - "$ref": "#/components/parameters/billing-usage-report-product" responses: '200': "$ref": "#/components/responses/billing_premium_request_usage_report_user" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/users/{username}/settings/billing/shared-storage": get: summary: Get shared storage billing for a user description: |- Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-shared-storage-billing-user tags: - billing externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - "$ref": "#/components/parameters/username" responses: '200': description: Response content: application/json: schema: "$ref": "#/components/schemas/combined-billing-usage" examples: default: "$ref": "#/components/examples/combined-billing-usage" x-github: githubCloudOnly: false enabledForGitHubApps: false category: billing subcategory: billing "/users/{username}/settings/billing/usage": get: summary: Get billing usage report for a user description: |- Gets a report of the total usage for a user. **Note:** This endpoint is only available to users with access to the enhanced billing platform. tags: - billing operationId: billing/get-github-billing-usage-report-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month" - "$ref": "#/components/parameters/billing-usage-report-day" responses: '200': "$ref": "#/components/responses/billing_usage_report_user" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. Gets a summary report of usage for a user. **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month-default" - "$ref": "#/components/parameters/billing-usage-report-day" - "$ref": "#/components/parameters/billing-usage-report-repository" - "$ref": "#/components/parameters/billing-usage-report-product" - "$ref": "#/components/parameters/billing-usage-report-sku" responses: '200': "$ref": "#/components/responses/billing_usage_summary_report_user" '400': "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false enabledForGitHubApps: true category: billing subcategory: enhanced-billing "/users/{username}/social_accounts": get: summary: List social accounts for a user description: Lists social media accounts for a user. This endpoint is accessible by anyone. tags: - users operationId: users/list-social-accounts-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/social-account" examples: default: "$ref": "#/components/examples/social-account-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: social-accounts "/users/{username}/ssh_signing_keys": get: summary: List SSH signing keys for a user description: Lists the SSH signing keys for a user. This operation is accessible by anyone. tags: - users operationId: users/list-ssh-signing-keys-for-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/ssh-signing-key" examples: default: "$ref": "#/components/examples/ssh-signing-key-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: users subcategory: ssh-signing-keys "/users/{username}/starred": get: summary: List repositories starred by a user description: |- Lists repositories a user has starred. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-repos-starred-by-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/sort-starred" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: anyOf: - type: array items: "$ref": "#/components/schemas/starred-repository" - type: array items: "$ref": "#/components/schemas/repository" examples: default-response: "$ref": "#/components/examples/repository-items-default-response" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: starring "/users/{username}/subscriptions": get: summary: List repositories watched by a user description: Lists repositories a user is watching. tags: - activity operationId: activity/list-repos-watched-by-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" responses: '200': description: Response content: application/json: schema: type: array items: "$ref": "#/components/schemas/minimal-repository" examples: default: "$ref": "#/components/examples/minimal-repository-items" headers: Link: "$ref": "#/components/headers/link" x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: watching "/versions": get: summary: Get all API versions description: Get all supported GitHub Enterprise Cloud API versions. tags: - meta operationId: meta/get-all-versions externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-all-api-versions responses: '200': description: Response content: application/json: schema: type: array items: type: string format: date example: '2021-01-01' examples: default: value: - '2021-01-01' - '2021-06-01' - '2022-01-01' '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true category: meta subcategory: meta "/zen": get: summary: Get the Zen of GitHub description: Get a random sentence from the Zen of GitHub tags: - meta operationId: meta/get-zen externalDocs: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/meta/meta#get-the-zen-of-github responses: '200': description: Response content: text/plain: schema: type: string examples: default: summary: Example response value: Responsive is better than fast x-github: githubCloudOnly: false enabledForGitHubApps: true category: meta subcategory: meta x-webhooks: branch-protection-configuration-disabled: post: summary: |- This event occurs when there is a change to branch protection configurations for a repository. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: All branch protections were disabled for a repository. operationId: branch-protection-configuration/disabled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-branch-protection-configuration-disabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_configuration supported-webhook-types: - repository - organization - app branch-protection-configuration-enabled: post: summary: |- This event occurs when there is a change to branch protection configurations for a repository. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: All branch protections were enabled for a repository. operationId: branch-protection-configuration/enabled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_configuration parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-branch-protection-configuration-enabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_configuration supported-webhook-types: - repository - organization - app branch-protection-rule-created: post: summary: |- This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was created. operationId: branch-protection-rule/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-branch-protection-rule-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_rule supported-webhook-types: - repository - organization - app branch-protection-rule-deleted: post: summary: |- This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was deleted. operationId: branch-protection-rule/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-branch-protection-rule-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_rule supported-webhook-types: - repository - organization - app branch-protection-rule-edited: post: summary: |- This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A branch protection rule was edited. operationId: branch-protection-rule/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#branch_protection_rule parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-branch-protection-rule-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: branch_protection_rule supported-webhook-types: - repository - organization - app bypass-request-secret-scanning-cancelled: post: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. Note: Delegated bypass for push protection is currently in public preview and subject to change. description: A secret scanning push protection bypass request was cancelled. operationId: exemption-request-secret-scanning/cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: bypass_request_secret_scanning supported-webhook-types: - repository - organization - app bypass-request-secret-scanning-completed: post: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. Note: Delegated bypass for push protection is currently in public preview and subject to change. description: A secret scanning bypass request was completed. operationId: exemption-request-secret-scanning/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: bypass_request_secret_scanning supported-webhook-types: - repository - organization - app bypass-request-secret-scanning-created: post: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. Note: Delegated bypass for push protection is currently in public preview and subject to change. description: A secret scanning push protection bypass request was created. operationId: exemption-request-secret-scanning/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: bypass_request_secret_scanning supported-webhook-types: - repository - organization - app bypass-request-secret-scanning-response-dismissed: post: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. Note: Delegated bypass for push protection is currently in public preview and subject to change. description: A secret scanning push protection bypass response was dismissed. operationId: exemption-request-secret-scanning/response-dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: bypass_request_secret_scanning supported-webhook-types: - repository - organization - app bypass-request-secret-scanning-response-submitted: post: summary: |- This event occurs when there is activity related to a user's request to bypass secret scanning push protection. For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. Note: Delegated bypass for push protection is currently in public preview and subject to change. description: A response either approving or rejecting the secret scanning push protection bypass request was submitted. operationId: exemption-request-secret-scanning/response-submitted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: bypass_request_secret_scanning supported-webhook-types: - repository - organization - app check-run-completed: post: summary: |- This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. > [!NOTE] > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A check run was completed, and a conclusion is available. operationId: check-run/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-check-run-completed" examples: default: "$ref": "#/components/examples/check-run-completed" application/x-www-form-urlencoded: schema: "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" examples: default: "$ref": "#/components/examples/check-run-completed-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-run-created: post: summary: |- This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. > [!NOTE] > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A new check run was created. operationId: check-run/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-check-run-created" examples: default: "$ref": "#/components/examples/check-run-created" application/x-www-form-urlencoded: schema: "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" examples: default: "$ref": "#/components/examples/check-run-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-run-requested-action: post: summary: |- This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. > [!NOTE] > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api)." operationId: check-run/requested-action externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-check-run-requested-action" examples: default: "$ref": "#/components/examples/check-run-requested-action" application/x-www-form-urlencoded: schema: "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" examples: default: "$ref": "#/components/examples/check-run-requested-action-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-run-rerequested: post: summary: |- This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)" in the REST API documentation. For activity relating to check suites, use the `check-suite` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. > [!NOTE] > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload. operationId: check-run/rerequested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-check-run-rerequested" examples: default: "$ref": "#/components/examples/check-run-rerequested" application/x-www-form-urlencoded: schema: "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" examples: default: "$ref": "#/components/examples/check-run-rerequested-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: check_run supported-webhook-types: - repository - organization - app check-suite-completed: post: summary: |- This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `completed` event types in repositories. > [!NOTE] > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: All check runs in a check suite have completed, and a conclusion is available. operationId: check-suite/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-check-suite-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: check_suite supported-webhook-types: - repository - organization - app check-suite-requested: post: summary: |- This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `completed` event types in repositories. > [!NOTE] > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or "[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)" in the REST API documentation. operationId: check-suite/requested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-check-suite-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: check_suite supported-webhook-types: - repository - organization - app check-suite-rerequested: post: summary: |- This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)" in the REST API documentation. For activity relating to check runs, use the `check_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. Repository and organization webhooks only receive payloads for the `completed` event types in repositories. > [!NOTE] > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. description: Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or "[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)" in the REST API documentation. operationId: check-suite/rerequested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-check-suite-rerequested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: check_suite supported-webhook-types: - repository - organization - app code-scanning-alert-appeared-in-branch: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert. operationId: code-scanning-alert/appeared-in-branch externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-closed-by-user: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: Someone closed a code scanning alert. operationId: code-scanning-alert/closed-by-user externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-created: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A code scanning alert was created in a repository. operationId: code-scanning-alert/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-code-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-fixed: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A code scanning alert was fixed in a branch by a commit. operationId: code-scanning-alert/fixed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: A previously fixed code scanning alert reappeared in a branch. operationId: code-scanning-alert/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app code-scanning-alert-reopened-by-user: post: summary: |- This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. description: Someone reopened a code scanning alert. operationId: code-scanning-alert/reopened-by-user externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app commit-comment-created: post: summary: |- This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)" in the REST API documentation. For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: Someone commented on a commit. operationId: commit-comment/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-commit-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: commit_comment supported-webhook-types: - repository - organization - app create: post: summary: |- This event occurs when a Git branch or tag is created. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. **Notes**: - This event will not occur when more than three tags are created at once. - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. operationId: create externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-create" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: create supported-webhook-types: - repository - organization - app custom-property-created: post: summary: |- This event occurs when there is activity relating to a custom property. For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A new custom property was created. operationId: custom-property/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-custom-property-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: custom_property supported-webhook-types: - business - organization - app custom-property-deleted: post: summary: |- This event occurs when there is activity relating to a custom property. For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was deleted. operationId: custom-property/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-custom-property-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: custom_property supported-webhook-types: - business - organization - app custom-property-promoted-to-enterprise: post: summary: |- This event occurs when there is activity relating to a custom property. For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was promoted to an enterprise. operationId: custom-property/promote-to-enterprise externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: custom_property supported-webhook-types: - business - organization - app custom-property-updated: post: summary: |- This event occurs when there is activity relating to a custom property. For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: A custom property was updated. operationId: custom-property/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: custom_property supported-webhook-types: - business - organization - app custom-property-values-updated: post: summary: |- This event occurs when there is activity relating to custom property values for a repository. For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. description: The custom property values of a repository were updated. operationId: custom-property-values/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: custom-property-values supported-webhook-types: - repository - organization - app delete: post: summary: |- This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including branch and tag deletions, use the [`push`](#push) webhook event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. > [!NOTE] > This event will not occur when more than three tags are deleted at once. operationId: delete externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-delete" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: delete supported-webhook-types: - repository - organization - app dependabot-alert-auto-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was automatically closed by a Dependabot auto-triage rule. operationId: dependabot-alert/auto-dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-auto-reopened: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. operationId: dependabot-alert/auto-reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-created: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable. operationId: dependabot-alert/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-dependabot-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was manually closed. operationId: dependabot-alert/dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-fixed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A manifest file change removed a vulnerability. operationId: dependabot-alert/fixed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-reintroduced: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A manifest file change introduced a vulnerable dependency that had previously been fixed. operationId: dependabot-alert/reintroduced externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app dependabot-alert-reopened: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. > [!NOTE] > Webhook events for Dependabot alerts are currently in public preview and subject to change. description: A Dependabot alert was manually reopened. operationId: dependabot-alert/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: dependabot_alert supported-webhook-types: - repository - organization - app deploy-key-created: post: summary: |- This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deploy key was created. operationId: deploy-key/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deploy-key-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deploy_key supported-webhook-types: - repository - organization - app deploy-key-deleted: post: summary: |- This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deploy key was deleted. operationId: deploy-key/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deploy-key-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deploy_key supported-webhook-types: - repository - organization - app deployment-created: post: summary: |- This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment status, use the `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deployment was created. operationId: deployment/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deployment-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment supported-webhook-types: - repository - organization - app deployment-protection-rule-requested: post: summary: |- This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments). To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deployment protection rule was requested for an environment. operationId: deployment-protection-rule/requested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_protection_rule supported-webhook-types: - app deployment-review-approved: post: summary: |- This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deployment review was approved. operationId: deployment-review/approved externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deployment-review-approved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_review supported-webhook-types: - app deployment-review-rejected: post: summary: |- This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deployment review was rejected. operationId: deployment-review/rejected externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deployment-review-rejected" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_review supported-webhook-types: - app deployment-review-requested: post: summary: |- This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. description: A deployment review was requested. operationId: deployment-review/requested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deployment-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_review supported-webhook-types: - app deployment-status-created: post: summary: |- This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)" in the REST API documentation. For activity relating to deployment creation, use the `deployment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. > [!NOTE] > A webhook event is not fired for deployment statuses with an `inactive` state. description: A new deployment status was created. operationId: deployment-status/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-deployment-status-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: deployment_status supported-webhook-types: - repository - organization - app discussion-answered: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on the discussion was marked as the answer. operationId: discussion/answered externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-answered" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-category-changed: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: The category of a discussion was changed. operationId: discussion/category-changed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-category-changed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-closed: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was closed. operationId: discussion/closed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-comment-created: post: summary: |- This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was created. operationId: discussion-comment/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion_comment supported-webhook-types: - repository - organization - app discussion-comment-deleted: post: summary: |- This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was deleted. operationId: discussion-comment/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion_comment supported-webhook-types: - repository - organization - app discussion-comment-edited: post: summary: |- This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on a discussion was edited. operationId: discussion-comment/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion_comment supported-webhook-types: - repository - organization - app discussion-created: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was created. operationId: discussion/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-deleted: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was deleted. operationId: discussion/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-edited: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: The title or body on a discussion was edited, or the category of the discussion was changed. operationId: discussion/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-labeled: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A label was added to a discussion. operationId: discussion/labeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-labeled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-locked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was locked. operationId: discussion/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-locked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-pinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was pinned. operationId: discussion/pinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-pinned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-reopened: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was reopened. operationId: discussion/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: discussions schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-transferred: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was transferred to another repository. operationId: discussion/transferred externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-transferred" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unanswered: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A comment on the discussion was unmarked as the answer. operationId: discussion/unanswered externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-unanswered" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unlabeled: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A label was removed from a discussion. operationId: discussion/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unlocked: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was unlocked. operationId: discussion/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app discussion-unpinned: post: summary: |- This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion). For activity relating to a comment on a discussion, use the `discussion_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. > [!NOTE] > Webhook events for GitHub Discussions are currently in public preview and subject to change. description: A discussion was unpinned. operationId: discussion/unpinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-discussion-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: discussion supported-webhook-types: - repository - organization - app dismissal-request-code-scanning-created: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. description: A code scanning alert dismissal request was created. operationId: dismissal-request-code-scanning/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: dismissal_request_code_scanning supported-webhook-types: - repository - organization - app dismissal-request-code-scanning-response-submitted: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a code scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. description: A code scanning alert dismissal response was submitted. operationId: dismissal-request-code-scanning/response-submitted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: dismissal_request_code_scanning supported-webhook-types: - repository - organization - app dismissal-request-secret-scanning-cancelled: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. description: A secret scanning alert dismissal request was canceled. operationId: dismissal-request-secret-scanning/cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app dismissal-request-secret-scanning-completed: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. description: A secret scanning alert dismissal request was completed. operationId: dismissal-request-secret-scanning/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app dismissal-request-secret-scanning-created: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. description: A secret scanning alert dismissal request was created. operationId: dismissal-request-secret-scanning/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app dismissal-request-secret-scanning-response-dismissed: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. description: A secret scanning alert dismissal response was dismissed. operationId: dismissal-request-secret-scanning/response-dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app dismissal-request-secret-scanning-response-submitted: post: summary: |- This event occurs when there is activity related to a user's request to dismiss a secret scanning alert. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. [!NOTE] Delegated alert dismissal for secret scanning is currently in public preview and subject to change. description: A secret scanning alert dismissal response was submitted. operationId: dismissal-request-secret-scanning/response-submitted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: dismissal_request_secret_scanning supported-webhook-types: - repository - organization - app exemption-request-push-ruleset-cancelled: post: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass request was cancelled. operationId: exemption-request-push-ruleset/cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: exemption_request_push_ruleset supported-webhook-types: - repository - organization - app exemption-request-push-ruleset-completed: post: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass request was completed. operationId: exemption-request-push-ruleset/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: exemption_request_push_ruleset supported-webhook-types: - repository - organization - app exemption-request-push-ruleset-created: post: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass request was created. operationId: exemption-request-push-ruleset/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: exemption_request_push_ruleset supported-webhook-types: - repository - organization - app exemption-request-push-ruleset-response-dismissed: post: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A push ruleset bypass response was dismissed. operationId: exemption-request-push-ruleset/response-dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: exemption_request_push_ruleset supported-webhook-types: - repository - organization - app exemption-request-push-ruleset-response-submitted: post: summary: |- This event occurs when there is activity related to a user's request to bypass a set of push rules. For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. description: A response either approving or rejecting the push ruleset bypass request was submitted. operationId: exemption-request-push-ruleset/response-submitted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: exemption_request_push_ruleset supported-webhook-types: - repository - organization - app fork: post: summary: |- This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: fork externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-fork" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: fork supported-webhook-types: - business - repository - organization - app github-app-authorization-revoked: post: summary: |- This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. A GitHub App receives this webhook by default and cannot unsubscribe from this event. Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." description: Someone revoked their authorization of a GitHub App. operationId: github-app-authorization/revoked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: github_app_authorization supported-webhook-types: - app gollum: post: summary: |- This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis)." To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: gollum externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-gollum" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: gollum supported-webhook-types: - repository - organization - app installation-created: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: Someone installed a GitHub App on a user or organization account. operationId: installation/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-deleted: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: Someone uninstalled a GitHub App from their user or organization account. operationId: installation/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-new-permissions-accepted: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: Someone granted new permissions to a GitHub App. operationId: installation/new-permissions-accepted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-repositories-added: post: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: A GitHub App installation was granted access to one or more repositories. operationId: installation-repositories/added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-repositories-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation_repositories supported-webhook-types: - app installation-repositories-removed: post: summary: |- This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: Access to one or more repositories was revoked for a GitHub App installation. operationId: installation-repositories/removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-repositories-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation_repositories supported-webhook-types: - app installation-suspend: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: Someone blocked access by a GitHub App to their user or organization account. operationId: installation/suspend externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-suspend" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app installation-target-renamed: post: summary: This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: Somebody renamed the user or organization account that a GitHub App is installed on. operationId: installation-target/renamed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-target-renamed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation_target supported-webhook-types: - app installation-unsuspend: post: summary: |- This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)" in the REST API documentation. description: A GitHub App that was blocked from accessing a user or organization account was given access the account again. operationId: installation/unsuspend externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-installation-unsuspend" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: installation supported-webhook-types: - app issue-comment-created: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was created. operationId: issue-comment/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issue-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue_comment supported-webhook-types: - repository - organization - app issue-comment-deleted: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was deleted. operationId: issue-comment/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issue-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue_comment supported-webhook-types: - repository - organization - app issue-comment-edited: post: summary: |- This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)" in the REST API documentation. For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A comment on an issue or pull request was edited. operationId: issue-comment/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issue-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue_comment supported-webhook-types: - repository - organization - app issue-dependencies-blocked-by-added: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: An issue was marked as blocked by another issue. operationId: issue-dependencies/blocked-by-added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue-dependencies supported-webhook-types: - repository - organization - app issue-dependencies-blocked-by-removed: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: The blocked by relationship between an issue and another issue was removed. operationId: issue-dependencies/blocked-by-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue-dependencies supported-webhook-types: - repository - organization - app issue-dependencies-blocking-added: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: An issue was marked as blocking another issue. operationId: issue-dependencies/blocking-added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue-dependencies supported-webhook-types: - repository - organization - app issue-dependencies-blocking-removed: post: summary: |- This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: The blocking relationship between an issue and another issue was removed. operationId: issue-dependencies/blocking-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issue-dependencies supported-webhook-types: - repository - organization - app issues-assigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was assigned to a user. operationId: issues/assigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-closed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was closed. operationId: issues/closed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was deleted. operationId: issues/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was removed from a milestone. operationId: issues/demilestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: The title or body on an issue was edited. operationId: issues/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A label was added to an issue. operationId: issues/labeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was added to a milestone. operationId: issues/milestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was created. When a closed issue is reopened, the action will be `reopened` instead. operationId: issues/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was pinned to a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/pinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-reopened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A closed issue was reopened. operationId: issues/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-transferred: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was transferred to another repository. For more information, see "[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." operationId: issues/transferred externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-typed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue type was added to an issue. operationId: issues/typed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unassigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A user was unassigned from an issue. operationId: issues/unassigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unlabeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: A label was removed from an issue. operationId: issues/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unlocked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." operationId: issues/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-unpinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue was unpinned from a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." operationId: issues/unpinned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app issues-untyped: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)" in the REST API documentation. For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. description: An issue type was removed from an issue. operationId: issues/untyped externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: issues supported-webhook-types: - repository - organization - app label-created: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A label was created. operationId: label/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: label supported-webhook-types: - repository - organization - app label-deleted: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A label was deleted. operationId: label/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: label supported-webhook-types: - repository - organization - app label-edited: post: summary: |- This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)" in the REST API documentation. If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A label's name, description, or color was changed. operationId: label/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: label supported-webhook-types: - repository - organization - app marketplace-purchase-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. description: Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. operationId: marketplace-purchase/cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: marketplace_purchase supported-webhook-types: - marketplace marketplace-purchase-changed: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. description: Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately. operationId: marketplace-purchase/changed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: marketplace_purchase supported-webhook-types: - marketplace marketplace-purchase-pending-change: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. description: Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent. operationId: marketplace-purchase/pending-change externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: marketplace_purchase supported-webhook-types: - marketplace marketplace-purchase-pending-change-cancelled: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. description: Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle. operationId: marketplace-purchase/pending-change-cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: marketplace_purchase supported-webhook-types: - marketplace marketplace-purchase-purchased: post: summary: This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace)." For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or "[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)" in the REST API documentation. description: Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately. operationId: marketplace-purchase/purchased externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: marketplace_purchase supported-webhook-types: - marketplace member-added: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A GitHub user accepted an invitation to a repository. operationId: member/added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: member supported-webhook-types: - business - repository - organization - app member-edited: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: Permissions were changed for a collaborator on a repository. operationId: member/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: member supported-webhook-types: - business - repository - organization - app member-removed: post: summary: |- This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A collaborator was removed from a repository. operationId: member/removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: member supported-webhook-types: - business - repository - organization - app membership-added: post: summary: |- This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was added to a team. operationId: membership/added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-membership-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: membership supported-webhook-types: - organization - business - app membership-removed: post: summary: |- This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization member was removed from a team. operationId: membership/removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-membership-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: membership supported-webhook-types: - organization - business - app merge-group-checks-requested: post: summary: |- This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. description: |- Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. operationId: merge-group/checks-requested tags: - merge-queue externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-merge-group-checks-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: merge_group supported-webhook-types: - app merge-group-destroyed: post: summary: |- This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. description: |- The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. operationId: merge-group/destroyed tags: - merge-queue externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-merge-group-destroyed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: merge_group supported-webhook-types: - app meta-deleted: post: summary: |- This event occurs when there is activity relating to a webhook itself. To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. description: The webhook was deleted. operationId: meta/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-meta-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: meta supported-webhook-types: - marketplace - business - repository - organization - app milestone-closed: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. description: A milestone was closed. operationId: milestone/closed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-milestone-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-created: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. description: A milestone was created. operationId: milestone/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-milestone-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-deleted: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. description: A milestone was deleted. operationId: milestone/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-milestone-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-edited: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. description: A milestone was edited. operationId: milestone/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-milestone-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app milestone-opened: post: summary: |- This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)" in the REST API documentation. If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. description: A milestone was opened. operationId: milestone/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-milestone-opened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: milestone supported-webhook-types: - repository - organization - app org-block-blocked: post: summary: |- This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. description: A user was blocked from the organization. operationId: org-block/blocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-org-block-blocked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: org_block supported-webhook-types: - organization - business - app org-block-unblocked: post: summary: |- This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)" in the REST API documentation. If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. description: A previously blocked user was unblocked from the organization. operationId: org-block/unblocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-org-block-unblocked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: org_block supported-webhook-types: - organization - business - app organization-custom-property-created: post: summary: This event occurs when there is activity relating to an organization custom property. description: A new organization custom property was created. operationId: organization-custom-property/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-custom-property-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: organization_custom_property supported-webhook-types: - business organization-custom-property-deleted: post: summary: This event occurs when there is activity relating to an organization custom property. description: An organization custom property was deleted. operationId: organization-custom-property/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: organization_custom_property supported-webhook-types: - business organization-custom-property-updated: post: summary: This event occurs when there is activity relating to an organization custom property. description: An organization custom property was updated. operationId: organization-custom-property/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: organization_custom_property supported-webhook-types: - business organization-custom-property-values-updated: post: summary: This event occurs when there is activity relating to custom property values for an organization. description: The custom property values of an organization were updated. operationId: organization-custom-property-values/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: true category: webhooks subcategory: organization-custom-property-values supported-webhook-types: - business - organization - app organization-deleted: post: summary: |- This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: An organization was deleted. operationId: organization/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-member-added: post: summary: |- This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A member accepted an invitation to join an organization. operationId: organization/member-added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-member-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-member-invited: post: summary: |- This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A member was invited to join the organization. operationId: organization/member-invited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-member-invited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-member-removed: post: summary: |- This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A member was removed from the organization. operationId: organization/member-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app organization-renamed: post: summary: |- This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)" in the REST API documentation. If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: The name of an organization was changed. operationId: organization/renamed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-organization-renamed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: organization supported-webhook-types: - organization - business - app package-published: post: summary: |- This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. description: A package was published to a registry. operationId: package/published externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-package-published" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: package supported-webhook-types: - repository - organization - app package-updated: post: summary: |- This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. description: A previously published package was updated. operationId: package/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: package supported-webhook-types: - repository - organization - app page-build: post: summary: |- This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. operationId: page-build externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-page-build" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: page_build supported-webhook-types: - repository - organization - app personal-access-token-request-approved: post: summary: |- This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was approved. operationId: personal-access-token-request/approved externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header example: personal_access_token_request schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: integration schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: personal_access_token_request supported-webhook-types: - app - organization personal-access-token-request-cancelled: post: summary: |- This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was cancelled by the requester. operationId: personal-access-token-request/cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header example: personal_access_token_request schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: integration schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: personal_access_token_request supported-webhook-types: - app - organization personal-access-token-request-created: post: summary: |- This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was created. operationId: personal-access-token-request/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header example: personal_access_token_request schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: integration schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-personal-access-token-request-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: personal_access_token_request supported-webhook-types: - app - organization personal-access-token-request-denied: post: summary: |- This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. description: A fine-grained personal access token request was denied. operationId: personal-access-token-request/denied externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header example: personal_access_token_request schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: integration schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: personal_access_token_request supported-webhook-types: - app - organization ping: post: summary: This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly. operationId: ping externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-ping" examples: default: "$ref": "#/components/examples/ping" application/x-www-form-urlencoded: schema: "$ref": "#/components/schemas/webhook-ping-form-encoded" examples: default: "$ref": "#/components/examples/ping-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: ping supported-webhook-types: - repository - organization - app - business - marketplace project-card-converted: post: summary: |- This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A note in a project (classic) was converted to an issue. operationId: project-card/converted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-card-converted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-created: post: summary: |- This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A card was added to a project (classic). operationId: project-card/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-card-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-deleted: post: summary: |- This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A card on a project (classic) was deleted. operationId: project-card/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-card-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-edited: post: summary: |- This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A note on a project (classic) was edited. operationId: project-card/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-card-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-card-moved: post: summary: |- This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A card on a project (classic) was moved to another column or to another position in its column. operationId: project-card/moved externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-card-moved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_card supported-webhook-types: - repository - organization - app project-closed: post: summary: |- This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A project (classic) was closed. operationId: project/closed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-column-created: post: summary: |- This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A column was added to a project (classic). operationId: project-column/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-column-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-column-deleted: post: summary: |- This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A column was deleted from a project (classic). operationId: project-column/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-column-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-column-edited: post: summary: |- This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: The name of a column on a project (classic) was changed. operationId: project-column/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-column-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-column-moved: post: summary: |- This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A column was moved to a new position on a project (classic). operationId: project-column/moved externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-column-moved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project_column supported-webhook-types: - repository - organization - app project-created: post: summary: |- This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A project (classic) was created. operationId: project/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-deleted: post: summary: |- This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A project (classic) was deleted. operationId: project/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-edited: post: summary: |- This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: The name or description of a project (classic) was changed. operationId: project/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app project-reopened: post: summary: |- This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)" in the REST API documentation. For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. description: A project (classic) was closed. operationId: project/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: project supported-webhook-types: - repository - organization - app projects-v2-closed: post: summary: |- This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was closed. operationId: projects-v2/closed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-created: post: summary: |- This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was created. operationId: projects-v2/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-project-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-deleted: post: summary: |- This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was deleted. operationId: projects-v2/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-edited: post: summary: |- This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: The title, description, or README of a project in the organization was changed. operationId: projects-v2/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-item-archived: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item on an organization project was archived. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/archived externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-item-archived" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-converted: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A draft issue in an organization project was converted to an issue. operationId: projects-v2-item/converted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-item-converted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-created: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item was added to a project in the organization. operationId: projects-v2-item/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-item-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-deleted: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An item was deleted from a project in the organization. operationId: projects-v2-item/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-edited: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue. operationId: projects-v2-item/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-item-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-reordered: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout. operationId: projects-v2-item/reordered externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-item-restored: post: summary: |- This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item). For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: An archived item on an organization project was restored from the archive. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." operationId: projects-v2-item/restored externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-item-restored" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_item supported-webhook-types: - organization projects-v2-reopened: post: summary: |- This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2). For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A project in the organization was reopened. operationId: projects-v2/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2 supported-webhook-types: - organization projects-v2-status-update-created: post: summary: |- This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A status update was added to a project in the organization. operationId: projects-v2-status-update/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_status_update supported-webhook-types: - organization projects-v2-status-update-deleted: post: summary: |- This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A status update was removed from a project in the organization. operationId: projects-v2-status-update/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_status_update supported-webhook-types: - organization projects-v2-status-update-edited: post: summary: |- This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For activity relating to a project, use the `projects_v2` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). description: A status update was edited on a project in the organization. operationId: projects-v2-status-update/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: projects_v2_status_update supported-webhook-types: - organization public: post: summary: |- This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. operationId: public externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-public" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: public supported-webhook-types: - repository - organization - app pull-request-assigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was assigned to a user. operationId: pull-request/assigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-assigned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-auto-merge-disabled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Auto merge was disabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-disabled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-auto-merge-enabled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Auto merge was enabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." operationId: pull-request/auto-merge-enabled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-closed: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged. operationId: pull-request/closed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-closed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-converted-to-draft: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was converted to a draft. For more information, see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/converted-to-draft externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-demilestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was removed from a milestone. operationId: pull-request/demilestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-dequeued: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was removed from the merge queue. operationId: pull-request/dequeued externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-dequeued" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-edited: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: The title or body of a pull request was edited, or the base branch of a pull request was changed. operationId: pull-request/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-enqueued: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was added to the merge queue. operationId: pull-request/enqueued externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-enqueued" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-labeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A label was added to a pull request. operationId: pull-request/labeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-labeled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-locked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Conversation on a pull request was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-locked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-milestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was added to a milestone. operationId: pull-request/milestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-opened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request was created operationId: pull-request/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-opened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-ready-for-review: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A draft pull request was marked as ready for review. For more information, see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." operationId: pull-request/ready-for-review externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-reopened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A previously closed pull request was reopened. operationId: pull-request/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-review-comment-created: post: summary: |- This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A comment on a pull request diff was created. operationId: pull-request-review-comment/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app pull-request-review-comment-deleted: post: summary: |- This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A comment on a pull request diff was deleted. operationId: pull-request-review-comment/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app pull-request-review-comment-edited: post: summary: |- This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: The content of a comment on a pull request diff was changed. operationId: pull-request-review-comment/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app pull-request-review-dismissed: post: summary: |- This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A review on a pull request was dismissed. operationId: pull-request-review/dismissed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review supported-webhook-types: - repository - organization - app pull-request-review-edited: post: summary: |- This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: The body comment on a pull request review was edited. operationId: pull-request-review/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review supported-webhook-types: - repository - organization - app pull-request-review-request-removed: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A request for review by a person or team was removed from a pull request. operationId: pull-request/review-request-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-review-requested: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Review by a person or team was requested for a pull request. For more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." operationId: pull-request/review-requested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-review-submitted: post: summary: |- This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A review on a pull request was submitted. operationId: pull-request-review/submitted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-submitted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review supported-webhook-types: - repository - organization - app pull-request-review-thread-resolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A comment thread on a pull request was marked as resolved. operationId: pull-request-review-thread/resolved externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app pull-request-review-thread-unresolved: post: summary: |- This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A previously resolved comment thread on a pull request was marked as unresolved. operationId: pull-request-review-thread/unresolved externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app pull-request-synchronize: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch. operationId: pull-request/synchronize externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-synchronize" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-unassigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A user was unassigned from a pull request. operationId: pull-request/unassigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-unlabeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: A label was removed from a pull request. operationId: pull-request/unlabeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app pull-request-unlocked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. description: Conversation on a pull request was unlocked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." operationId: pull-request/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-pull-request-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: pull_request supported-webhook-types: - repository - organization - app push: post: summary: |- This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch and tag deletions, use the [`delete`](#delete) webhook event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. > [!NOTE] > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. operationId: push externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-push" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: push supported-webhook-types: - repository - organization - app registry-package-published: post: summary: |- This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. > [!NOTE] > GitHub recommends that you use the newer `package` event instead. description: A package was published to a registry. operationId: registry-package/published externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-registry-package-published" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: registry_package supported-webhook-types: - repository - organization - app registry-package-updated: post: summary: |- This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. > [!NOTE] > GitHub recommends that you use the newer `package` event instead. description: A package that was previously published to a registry was updated. operationId: registry-package/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-registry-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: registry_package supported-webhook-types: - repository - organization - app release-created: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A draft was saved, or a release or pre-release was published without previously being saved as a draft. operationId: release/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-release-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-deleted: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft release was deleted. operationId: release/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-release-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-edited: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: The details of a release, pre-release, or draft release were edited. For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." operationId: release/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-release-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-prereleased: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable. operationId: release/prereleased externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-release-prereleased" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-published: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release, pre-release, or draft of a release was published. operationId: release/published externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-release-published" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-released: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release was published, or a pre-release was changed to a release. operationId: release/released externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-release-released" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app release-unpublished: post: summary: |- This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. description: A release or pre-release was unpublished. operationId: release/unpublished externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-release-unpublished" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: release supported-webhook-types: - repository - organization - app repository-advisory-published: post: summary: |- This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. description: A repository security advisory was published. operationId: repository-advisory/published externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_advisory supported-webhook-types: - repository - organization - app repository-advisory-reported: post: summary: |- This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. description: A private vulnerability report was submitted. operationId: repository-advisory/reported externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-advisory-reported" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_advisory supported-webhook-types: - repository - organization - app repository-archived: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was archived. operationId: repository/archived externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-archived" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-created: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was created. operationId: repository/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-deleted: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A repository was deleted. GitHub Apps and repository webhooks will not receive this event. operationId: repository/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-dispatch-sample.collected: post: summary: |- This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: repository-dispatch/sample.collected externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-dispatch-sample" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_dispatch supported-webhook-types: - app repository-edited: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The topics, default branch, description, or homepage of a repository was changed. operationId: repository/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-import: post: summary: This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports). operationId: repository-import externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-import" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_import supported-webhook-types: - repository - organization repository-privatized: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The visibility of a repository was changed to `private`. operationId: repository/privatized externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-privatized" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-publicized: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The visibility of a repository was changed to `public`. operationId: repository/publicized externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-publicized" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-renamed: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: The name of a repository was changed. operationId: repository/renamed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-renamed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-ruleset-created: post: summary: |- This event occurs when there is activity relating to repository rulesets. For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was created. operationId: repository-ruleset/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_ruleset supported-webhook-types: - repository - organization - app repository-ruleset-deleted: post: summary: |- This event occurs when there is activity relating to repository rulesets. For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was deleted. operationId: repository-ruleset/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_ruleset supported-webhook-types: - repository - organization - app repository-ruleset-edited: post: summary: |- This event occurs when there is activity relating to repository rulesets. For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. description: A repository ruleset was edited. operationId: repository-ruleset/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_ruleset supported-webhook-types: - repository - organization - app repository-transferred: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to "Repository" events. operationId: repository/transferred externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-unarchived: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: A previously archived repository was unarchived. operationId: repository/unarchived externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-unarchived" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository supported-webhook-types: - business - repository - organization - app repository-vulnerability-alert-create: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was created. operationId: repository-vulnerability-alert/create externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization repository-vulnerability-alert-dismiss: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was dismissed. operationId: repository-vulnerability-alert/dismiss externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization repository-vulnerability-alert-reopen: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A previously dismissed or resolved repository vulnerability alert was reopened. operationId: repository-vulnerability-alert/reopen externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization repository-vulnerability-alert-resolve: post: summary: |- This event occurs when there is activity relating to a security vulnerability alert in a repository. > [!WARNING] > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. description: A repository vulnerability alert was marked as resolved. operationId: repository-vulnerability-alert/resolve externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization secret-scanning-alert-created: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A secret scanning alert was created. operationId: secret-scanning-alert/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-alert-location-created: post: summary: |- This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert. operationId: secret-scanning-alert-location/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" examples: default: "$ref": "#/components/examples/secret-scanning-alert-location-created" application/x-www-form-urlencoded: schema: "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" examples: default: "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false enabledForGitHubApps: true category: webhooks subcategory: secret_scanning_alert_location supported-webhook-types: - repository - organization - app secret-scanning-alert-publicly-leaked: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A secret scanning alert was detected in a public repo. operationId: secret-scanning-alert/publicly-leaked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-alert-reopened: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A previously closed secret scanning alert was reopened. operationId: secret-scanning-alert/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-alert-resolved: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A secret scanning alert was closed. operationId: secret-scanning-alert/resolved externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-alert-validated: post: summary: |- This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A secret scanning alert was validated. operationId: secret-scanning-alert/validated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app secret-scanning-scan-completed: post: summary: |- This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. description: A secret scanning scan was completed. operationId: secret-scanning-scan/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: secret_scanning_scan supported-webhook-types: - repository - organization - app security-advisory-published: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: A security advisory was published to the GitHub community. operationId: security-advisory/published externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_advisory supported-webhook-types: - app security-advisory-updated: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: The metadata or description of a security advisory was changed. operationId: security-advisory/updated externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_advisory supported-webhook-types: - app security-advisory-withdrawn: post: summary: |- This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." description: A previously published security advisory was withdrawn. operationId: security-advisory/withdrawn externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_advisory supported-webhook-types: - app security-and-analysis: post: summary: |- This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. operationId: security-and-analysis externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: security_and_analysis supported-webhook-types: - repository - organization - app sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- A sponsorship was cancelled and the last billing cycle has ended. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed. operationId: sponsorship/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs. operationId: sponsorship/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-pending-cancellation: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-pending-tier-change: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date. operationId: sponsorship/pending-tier-change externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing sponsorship-tier-changed: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle. operationId: sponsorship/tier-changed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sponsorship supported-webhook-types: - sponsors_listing star-created: post: summary: |- This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone starred a repository. operationId: star/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: star supported-webhook-types: - repository - organization - app star-deleted: post: summary: |- This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone unstarred the repository. operationId: star/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: star supported-webhook-types: - repository - organization - app status: post: summary: |- This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. operationId: status externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: status supported-webhook-types: - repository - organization - app sub-issues-parent-issue-added: post: summary: |- This event occurs when there is activity relating to sub-issues. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: A parent issue was added to an issue. operationId: sub-issues/parent-issue-added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sub-issues supported-webhook-types: - repository - organization - app sub-issues-parent-issue-removed: post: summary: |- This event occurs when there is activity relating to sub-issues. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: A parent issue was removed from an issue. operationId: sub-issues/parent-issue-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sub-issues supported-webhook-types: - repository - organization - app sub-issues-sub-issue-added: post: summary: |- This event occurs when there is activity relating to sub-issues. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: A sub-issue was added to an issue. operationId: sub-issues/sub-issue-added externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sub-issues supported-webhook-types: - repository - organization - app sub-issues-sub-issue-removed: post: summary: |- This event occurs when there is activity relating to sub-issues. For activity relating to issues more generally, use the `issues` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. description: A sub-issue was removed from an issue. operationId: sub-issues/sub-issue-removed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: sub-issues supported-webhook-types: - repository - organization - app team-add: post: summary: |- This event occurs when a team is added to a repository. For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. operationId: team-add externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-team-add" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team_add supported-webhook-types: - repository - organization - app team-added-to-repository: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was granted access to a repository. operationId: team/added-to-repository externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-team-added-to-repository" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-created: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was created. operationId: team/created externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-team-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-deleted: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team was deleted. operationId: team/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-team-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-edited: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: The name, description, or visibility of a team was changed. operationId: team/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-team-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app team-removed-from-repository: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. description: A team's access to a repository was removed. operationId: team/removed-from-repository externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-team-removed-from-repository" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: team supported-webhook-types: - organization - business - app watch-started: post: summary: |- This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest//account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. description: Someone started watching the repository. operationId: watch/started externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#watch parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-watch-started" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: watch supported-webhook-types: - repository - organization - app workflow-dispatch: post: summary: |- This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/manually-running-a-workflow)." For activity relating to workflow runs, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. operationId: workflow-dispatch externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-dispatch" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_dispatch supported-webhook-types: - app workflow-job-completed: post: summary: |- This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful. operationId: workflow-job/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-job-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-job-in-progress: post: summary: |- This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A job in a workflow run started processing on a runner. operationId: workflow-job/in-progress externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-job-in-progress" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-job-queued: post: summary: |- This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A job in a workflow run was created. operationId: workflow-job/queued externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-job-queued" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-job-waiting: post: summary: |- This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)" in the REST API documentation. For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A job in a workflow run was created and is waiting for approvals. operationId: workflow-job/waiting externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-job-waiting" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_job supported-webhook-types: - business - repository - organization - app workflow-run-completed: post: summary: |- This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful. operationId: workflow-run/completed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-run-completed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_run supported-webhook-types: - business - repository - organization - app workflow-run-in-progress: post: summary: |- This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A workflow run started processing on a runner. operationId: workflow-run/in-progress externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-run-in-progress" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_run supported-webhook-types: - business - repository - organization - app workflow-run-requested: post: summary: |- This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)" in the REST API documentation. For activity relating to a job in a workflow run, use the `workflow_job` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. description: A workflow run was triggered. operationId: workflow-run/requested externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - name: X-Github-Hook-Id in: header example: 12312312 schema: type: string - name: X-Github-Event in: header example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id in: header example: 123123 schema: type: string - name: X-Github-Hook-Installation-Target-Type in: header example: repository schema: type: string - name: X-GitHub-Delivery in: header example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Hub-Signature-256 in: header example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/webhook-workflow-run-requested" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false category: webhooks subcategory: workflow_run supported-webhook-types: - business - repository - organization - app components: schemas: root: type: object properties: current_user_url: type: string format: uri-template current_user_authorizations_html_url: type: string format: uri-template authorizations_url: type: string format: uri-template code_search_url: type: string format: uri-template commit_search_url: type: string format: uri-template emails_url: type: string format: uri-template emojis_url: type: string format: uri-template events_url: type: string format: uri-template feeds_url: type: string format: uri-template followers_url: type: string format: uri-template following_url: type: string format: uri-template gists_url: type: string format: uri-template hub_url: type: string format: uri-template deprecated: true issue_search_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template label_search_url: type: string format: uri-template notifications_url: type: string format: uri-template organization_url: type: string format: uri-template organization_repositories_url: type: string format: uri-template organization_teams_url: type: string format: uri-template public_gists_url: type: string format: uri-template rate_limit_url: type: string format: uri-template repository_url: type: string format: uri-template repository_search_url: type: string format: uri-template current_user_repositories_url: type: string format: uri-template starred_url: type: string format: uri-template starred_gists_url: type: string format: uri-template topic_search_url: type: string format: uri-template user_url: type: string format: uri-template user_organizations_url: type: string format: uri-template user_repositories_url: type: string format: uri-template user_search_url: type: string format: uri-template required: - current_user_url - current_user_authorizations_html_url - authorizations_url - code_search_url - commit_search_url - emails_url - emojis_url - events_url - feeds_url - followers_url - following_url - gists_url - issue_search_url - issues_url - keys_url - label_search_url - notifications_url - organization_url - organization_repositories_url - organization_teams_url - public_gists_url - rate_limit_url - repository_url - repository_search_url - current_user_repositories_url - starred_url - starred_gists_url - user_url - user_organizations_url - user_repositories_url - user_search_url security-advisory-ecosystems: type: string description: The package's language or package management ecosystem. enum: - rubygems - npm - pip - maven - nuget - composer - go - rust - erlang - actions - pub - other - swift vulnerability: description: A vulnerability describing the product and its affected versions within a GitHub Security Advisory. type: object properties: package: description: The name of the package affected by the vulnerability. type: object nullable: true properties: ecosystem: "$ref": "#/components/schemas/security-advisory-ecosystems" name: type: string description: The unique package name within its ecosystem. nullable: true required: - ecosystem - name vulnerable_version_range: type: string description: The range of the package versions affected by the vulnerability. nullable: true first_patched_version: type: string description: The package version that resolves the vulnerability. nullable: true vulnerable_functions: type: array description: The functions in the package that are affected by the vulnerability. nullable: true readOnly: true items: type: string required: - package - vulnerable_version_range - first_patched_version - vulnerable_functions cvss-severities: type: object nullable: true properties: cvss_v3: type: object nullable: true properties: vector_string: type: string description: The CVSS 3 vector string. nullable: true score: type: number description: The CVSS 3 score. minimum: 0 maximum: 10 nullable: true readOnly: true required: - vector_string - score cvss_v4: type: object nullable: true properties: vector_string: type: string description: The CVSS 4 vector string. nullable: true score: type: number description: The CVSS 4 score. minimum: 0 maximum: 10 nullable: true readOnly: true required: - vector_string - score security-advisory-epss: type: object nullable: true readOnly: true description: The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). properties: percentage: type: number minimum: 0 maximum: 100 percentile: type: number minimum: 0 maximum: 100 simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' user_view_type: type: string example: public required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url security-advisory-credit-types: type: string description: The type of credit the user is receiving. enum: - analyst - finder - reporter - coordinator - remediation_developer - remediation_reviewer - remediation_verifier - tool - sponsor - other global-advisory: description: A GitHub Security Advisory. type: object properties: ghsa_id: type: string description: The GitHub Security Advisory ID. readOnly: true cve_id: type: string description: The Common Vulnerabilities and Exposures (CVE) ID. nullable: true readOnly: true url: type: string description: The API URL for the advisory. readOnly: true html_url: type: string format: uri description: The URL for the advisory. readOnly: true repository_advisory_url: type: string format: uri description: The API URL for the repository advisory. readOnly: true nullable: true summary: type: string description: A short summary of the advisory. maxLength: 1024 description: type: string description: A detailed description of what the advisory entails. maxLength: 65535 nullable: true type: type: string description: The type of advisory. readOnly: true enum: - reviewed - unreviewed - malware severity: type: string description: The severity of the advisory. enum: - critical - high - medium - low - unknown source_code_location: type: string format: uri description: The URL of the advisory's source code. nullable: true identifiers: type: array nullable: true readOnly: true items: type: object properties: type: type: string description: The type of identifier. enum: - CVE - GHSA value: type: string description: The identifier value. required: - type - value references: type: array nullable: true items: type: string description: URLs with more information regarding the advisory. published_at: type: string format: date-time description: The date and time of when the advisory was published, in ISO 8601 format. readOnly: true updated_at: type: string format: date-time description: The date and time of when the advisory was last updated, in ISO 8601 format. readOnly: true github_reviewed_at: type: string format: date-time description: The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. readOnly: true nullable: true nvd_published_at: type: string format: date-time description: |- The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. This field is only populated when the advisory is imported from the National Vulnerability Database. readOnly: true nullable: true withdrawn_at: type: string format: date-time description: The date and time of when the advisory was withdrawn, in ISO 8601 format. readOnly: true nullable: true vulnerabilities: type: array description: The products and respective version ranges affected by the advisory. nullable: true items: "$ref": "#/components/schemas/vulnerability" cvss: type: object nullable: true properties: vector_string: type: string description: The CVSS vector. nullable: true score: type: number description: The CVSS score. minimum: 0 maximum: 10 nullable: true readOnly: true required: - vector_string - score cvss_severities: "$ref": "#/components/schemas/cvss-severities" epss: "$ref": "#/components/schemas/security-advisory-epss" cwes: type: array nullable: true items: type: object properties: cwe_id: type: string description: The Common Weakness Enumeration (CWE) identifier. name: type: string description: The name of the CWE. readOnly: true required: - cwe_id - name credits: type: array description: The users who contributed to the advisory. nullable: true readOnly: true items: type: object properties: user: "$ref": "#/components/schemas/simple-user" type: "$ref": "#/components/schemas/security-advisory-credit-types" required: - user - type required: - ghsa_id - cve_id - url - html_url - repository_advisory_url - summary - description - type - severity - source_code_location - identifiers - references - published_at - updated_at - github_reviewed_at - nvd_published_at - withdrawn_at - vulnerabilities - cvss - cwes - credits additionalProperties: false basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string documentation_url: type: string url: type: string status: type: string validation-error-simple: title: Validation Error Simple description: Validation Error Simple type: object required: - message - documentation_url properties: message: type: string documentation_url: type: string errors: type: array items: type: string enterprise: title: Enterprise description: An enterprise on GitHub. type: object properties: description: description: A short description of the enterprise. type: string nullable: true html_url: type: string format: uri example: https://github.com/enterprises/octo-business website_url: description: The enterprise's website URL. type: string nullable: true format: uri id: description: Unique identifier of the enterprise example: 42 type: integer node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the enterprise. type: string example: Octo Business slug: description: The slug url identifier for the enterprise. type: string example: octo-business created_at: type: string nullable: true format: date-time example: '2019-01-26T19:01:12Z' updated_at: type: string nullable: true format: date-time example: '2019-01-26T19:14:43Z' avatar_url: type: string format: uri required: - id - node_id - name - slug - html_url - created_at - updated_at - avatar_url integration: title: GitHub app description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: id: description: Unique identifier of the GitHub app example: 37 type: integer slug: description: The slug name of the GitHub app example: probot-owners type: string node_id: type: string example: MDExOkludGVncmF0aW9uMQ== client_id: type: string example: '"Iv1.25b5d1e65ffc4022"' owner: oneOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/enterprise" name: description: The name of the GitHub app example: Probot Owners type: string description: type: string example: The description of the app. nullable: true external_url: type: string format: uri example: https://example.com html_url: type: string format: uri example: https://github.com/apps/super-ci created_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' updated_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' permissions: description: The set of permissions for the GitHub app type: object properties: issues: type: string checks: type: string metadata: type: string contents: type: string deployments: type: string additionalProperties: type: string example: issues: read deployments: write events: description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. example: - label - deployment type: array items: type: string installations_count: description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. example: 5 type: integer required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at - permissions - events webhook-config-url: type: string description: The URL to which the payloads will be delivered. example: https://example.com/webhook format: uri webhook-config-content-type: type: string description: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. example: '"json"' webhook-config-secret: type: string description: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers). example: '"********"' webhook-config-insecure-ssl: oneOf: - type: string description: Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** example: '"0"' - type: number webhook-config: title: Webhook Configuration description: Configuration object of the webhook type: object properties: url: "$ref": "#/components/schemas/webhook-config-url" content_type: "$ref": "#/components/schemas/webhook-config-content-type" secret: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" hook-delivery-item: title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. type: object properties: id: description: Unique identifier of the webhook delivery. type: integer format: int64 example: 42 guid: description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). type: string example: 58474f00-b361-11eb-836d-0e4f3503ccbe delivered_at: description: Time when the webhook delivery occurred. type: string format: date-time example: '2021-05-12T20:33:44Z' redelivery: description: Whether the webhook delivery is a redelivery. type: boolean example: false duration: description: Time spent delivering. type: number example: 0.03 status: description: Describes the response returned after attempting the delivery. type: string example: failed to connect status_code: description: Status code received when delivery was made. type: integer example: 502 event: description: The event that triggered the delivery. type: string example: issues action: description: The type of activity for the event that triggered the delivery. type: string example: opened nullable: true installation_id: description: The id of the GitHub App installation associated with this event. type: integer format: int64 example: 123 nullable: true repository_id: description: The id of the repository associated with this event. type: integer format: int64 example: 123 nullable: true throttled_at: description: Time when the webhook delivery was throttled. type: string format: date-time example: '2021-05-12T20:33:44Z' nullable: true required: - id - guid - delivered_at - redelivery - duration - status - status_code - event - action - installation_id - repository_id scim-error: title: Scim Error description: Scim Error type: object properties: message: type: string nullable: true documentation_url: type: string nullable: true detail: type: string nullable: true status: type: integer scimType: type: string nullable: true schemas: type: array items: type: string validation-error: title: Validation Error description: Validation Error type: object required: - message - documentation_url properties: message: type: string documentation_url: type: string errors: type: array items: type: object required: - code properties: resource: type: string field: type: string message: type: string code: type: string index: type: integer value: oneOf: - type: string nullable: true - type: integer nullable: true - type: array nullable: true items: type: string hook-delivery: title: Webhook delivery description: Delivery made by a webhook. type: object properties: id: description: Unique identifier of the delivery. type: integer example: 42 guid: description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). type: string example: 58474f00-b361-11eb-836d-0e4f3503ccbe delivered_at: description: Time when the delivery was delivered. type: string format: date-time example: '2021-05-12T20:33:44Z' redelivery: description: Whether the delivery is a redelivery. type: boolean example: false duration: description: Time spent delivering. type: number example: 0.03 status: description: Description of the status of the attempted delivery type: string example: failed to connect status_code: description: Status code received when delivery was made. type: integer example: 502 event: description: The event that triggered the delivery. type: string example: issues action: description: The type of activity for the event that triggered the delivery. type: string example: opened nullable: true installation_id: description: The id of the GitHub App installation associated with this event. type: integer example: 123 nullable: true repository_id: description: The id of the repository associated with this event. type: integer example: 123 nullable: true throttled_at: description: Time when the webhook delivery was throttled. type: string format: date-time example: '2021-05-12T20:33:44Z' nullable: true url: description: The URL target of the delivery. type: string example: https://www.example.com request: type: object properties: headers: description: The request headers sent with the webhook delivery. type: object nullable: true additionalProperties: true payload: description: The webhook payload. type: object nullable: true additionalProperties: true required: - headers - payload response: type: object properties: headers: description: The response headers received when the delivery was made. type: object nullable: true additionalProperties: true payload: description: The response payload received. type: string nullable: true additionalProperties: true required: - headers - payload required: - id - guid - delivered_at - redelivery - duration - status - status_code - event - action - installation_id - repository_id - request - response integration-installation-request: title: Integration Installation Request description: Request to install an integration on a target type: object properties: id: description: Unique identifier of the request installation. type: integer example: 42 node_id: type: string example: MDExOkludGVncmF0aW9uMQ== account: anyOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/enterprise" requester: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2022-07-08T16:18:44-04:00' required: - id - account - requester - created_at app-permissions: title: App Permissions type: object description: The permissions granted to the user access token. properties: actions: type: string description: The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. enum: - read - write administration: type: string description: The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. enum: - read - write attestations: type: string description: The level of permission to create and retrieve the access token for repository attestations. enum: - read - write checks: type: string description: The level of permission to grant the access token for checks on code. enum: - read - write codespaces: type: string description: The level of permission to grant the access token to create, edit, delete, and list Codespaces. enum: - read - write contents: type: string description: The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. enum: - read - write dependabot_secrets: type: string description: The level of permission to grant the access token to manage Dependabot secrets. enum: - read - write deployments: type: string description: The level of permission to grant the access token for deployments and deployment statuses. enum: - read - write discussions: type: string description: The level of permission to grant the access token for discussions and related comments and labels. enum: - read - write environments: type: string description: The level of permission to grant the access token for managing repository environments. enum: - read - write issues: type: string description: The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. enum: - read - write merge_queues: type: string description: The level of permission to grant the access token to manage the merge queues for a repository. enum: - read - write metadata: type: string description: The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. enum: - read - write packages: type: string description: The level of permission to grant the access token for packages published to GitHub Packages. enum: - read - write pages: type: string description: The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. enum: - read - write pull_requests: type: string description: The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. enum: - read - write repository_custom_properties: type: string description: The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. enum: - read - write repository_hooks: type: string description: The level of permission to grant the access token to manage the post-receive hooks for a repository. enum: - read - write repository_projects: type: string description: The level of permission to grant the access token to manage repository projects, columns, and cards. enum: - read - write - admin secret_scanning_alerts: type: string description: The level of permission to grant the access token to view and manage secret scanning alerts. enum: - read - write secrets: type: string description: The level of permission to grant the access token to manage repository secrets. enum: - read - write security_events: type: string description: The level of permission to grant the access token to view and manage security events like code scanning alerts. enum: - read - write single_file: type: string description: The level of permission to grant the access token to manage just a single file. enum: - read - write statuses: type: string description: The level of permission to grant the access token for commit statuses. enum: - read - write vulnerability_alerts: type: string description: The level of permission to grant the access token to manage Dependabot alerts. enum: - read - write workflows: type: string description: The level of permission to grant the access token to update GitHub Actions workflow files. enum: - write custom_properties_for_organizations: type: string description: The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. enum: - read - write members: type: string description: The level of permission to grant the access token for organization teams and members. enum: - read - write organization_administration: type: string description: The level of permission to grant the access token to manage access to an organization. enum: - read - write organization_custom_roles: type: string description: The level of permission to grant the access token for custom repository roles management. enum: - read - write organization_custom_org_roles: type: string description: The level of permission to grant the access token for custom organization roles management. enum: - read - write organization_custom_properties: type: string description: The level of permission to grant the access token for repository custom properties management at the organization level. enum: - read - write - admin organization_copilot_seat_management: type: string description: The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. enum: - write organization_announcement_banners: type: string description: The level of permission to grant the access token to view and manage announcement banners for an organization. enum: - read - write organization_events: type: string description: The level of permission to grant the access token to view events triggered by an activity in an organization. enum: - read organization_hooks: type: string description: The level of permission to grant the access token to manage the post-receive hooks for an organization. enum: - read - write organization_personal_access_tokens: type: string description: The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. enum: - read - write organization_personal_access_token_requests: type: string description: The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. enum: - read - write organization_plan: type: string description: The level of permission to grant the access token for viewing an organization's plan. enum: - read organization_projects: type: string description: The level of permission to grant the access token to manage organization projects and projects public preview (where available). enum: - read - write - admin organization_packages: type: string description: The level of permission to grant the access token for organization packages published to GitHub Packages. enum: - read - write organization_secrets: type: string description: The level of permission to grant the access token to manage organization secrets. enum: - read - write organization_self_hosted_runners: type: string description: The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. enum: - read - write organization_user_blocking: type: string description: The level of permission to grant the access token to view and manage users blocked by the organization. enum: - read - write team_discussions: type: string description: The level of permission to grant the access token to manage team discussions and related comments. enum: - read - write email_addresses: type: string description: The level of permission to grant the access token to manage the email addresses belonging to a user. enum: - read - write followers: type: string description: The level of permission to grant the access token to manage the followers belonging to a user. enum: - read - write git_ssh_keys: type: string description: The level of permission to grant the access token to manage git SSH keys. enum: - read - write gpg_keys: type: string description: The level of permission to grant the access token to view and manage GPG keys belonging to a user. enum: - read - write interaction_limits: type: string description: The level of permission to grant the access token to view and manage interaction limits on a repository. enum: - read - write profile: type: string description: The level of permission to grant the access token to manage the profile settings belonging to a user. enum: - write starring: type: string description: The level of permission to grant the access token to list and manage repositories a user is starring. enum: - read - write enterprise_custom_properties_for_organizations: type: string description: The level of permission to grant the access token for organization custom properties management at the enterprise level. enum: - read - write - admin enterprise_organization_installations: type: string description: The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations. enum: - read - write enterprise_organization_installation_repositories: type: string description: The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations. enum: - read - write example: contents: read issues: read deployments: write single_file: read nullable-simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' user_view_type: type: string example: public required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url nullable: true installation: title: Installation description: Installation type: object properties: id: description: The ID of the installation. type: integer example: 1 account: nullable: true anyOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/enterprise" repository_selection: description: Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`. type: string enum: - all - selected access_tokens_url: type: string format: uri example: https://api.github.com/app/installations/1/access_tokens repositories_url: type: string format: uri example: https://api.github.com/installation/repositories html_url: type: string format: uri example: https://github.com/organizations/github/settings/installations/1 app_id: type: integer example: 1 client_id: type: string example: Iv1.ab1112223334445c target_id: description: The ID of the user or organization this token is being scoped to. type: integer target_type: type: string example: Organization permissions: "$ref": "#/components/schemas/app-permissions" events: type: array items: type: string created_at: type: string format: date-time updated_at: type: string format: date-time single_file_name: type: string example: config.yaml nullable: true has_multiple_single_files: type: boolean example: true single_file_paths: type: array items: type: string example: - config.yml - ".github/issue_TEMPLATE.md" app_slug: type: string example: github-actions suspended_by: "$ref": "#/components/schemas/nullable-simple-user" suspended_at: type: string format: date-time nullable: true contact_email: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true required: - id - app_id - app_slug - target_id - target_type - single_file_name - repository_selection - access_tokens_url - html_url - repositories_url - events - account - permissions - created_at - updated_at - suspended_by - suspended_at nullable-license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string nullable: true format: uri example: https://api.github.com/licenses/mit spdx_id: type: string nullable: true example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri required: - key - name - url - spdx_id - node_id nullable: true repository: title: Repository description: A repository on GitHub. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" forks: type: integer permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push owner: "$ref": "#/components/schemas/simple-user" private: description: Whether the repository is private or public. default: false type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true deprecated: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_update_branch: description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. default: false type: boolean example: false use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo type: boolean web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean open_issues: type: integer watchers: type: integer master_branch: type: string starred_at: type: string example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository code_search_index_status: type: object description: The status of the code search index for this repository properties: lexical_search_ok: type: boolean lexical_commit_sha: type: string required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at installation-token: title: Installation Token description: Authentication token for a GitHub App installed on a user, org, or enterprise. type: object properties: token: type: string expires_at: type: string permissions: "$ref": "#/components/schemas/app-permissions" repository_selection: type: string enum: - all - selected repositories: type: array items: "$ref": "#/components/schemas/repository" single_file: type: string example: README.md has_multiple_single_files: type: boolean example: true single_file_paths: type: array items: type: string example: - config.yml - ".github/issue_TEMPLATE.md" required: - token - expires_at nullable-scoped-installation: title: Scoped Installation type: object properties: permissions: "$ref": "#/components/schemas/app-permissions" repository_selection: description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected single_file_name: type: string example: config.yaml nullable: true has_multiple_single_files: type: boolean example: true single_file_paths: type: array items: type: string example: - config.yml - ".github/issue_TEMPLATE.md" repositories_url: type: string format: uri example: https://api.github.com/users/octocat/repos account: "$ref": "#/components/schemas/simple-user" required: - permissions - repository_selection - single_file_name - repositories_url - account nullable: true authorization: title: Authorization description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object properties: id: type: integer format: int64 url: type: string format: uri scopes: description: A list of scopes that this authorization is in. type: array items: type: string nullable: true token: type: string token_last_eight: type: string nullable: true hashed_token: type: string nullable: true app: type: object properties: client_id: type: string name: type: string url: type: string format: uri required: - client_id - name - url note: type: string nullable: true note_url: type: string format: uri nullable: true updated_at: type: string format: date-time created_at: type: string format: date-time fingerprint: type: string nullable: true user: "$ref": "#/components/schemas/nullable-simple-user" installation: "$ref": "#/components/schemas/nullable-scoped-installation" expires_at: type: string format: date-time nullable: true required: - app - id - note - note_url - scopes - token - hashed_token - token_last_eight - fingerprint - url - created_at - updated_at - expires_at simple-classroom-repository: title: Simple Classroom Repository description: A GitHub repository view for Classroom type: object properties: id: type: integer example: 1296269 description: A unique identifier of the repository. full_name: type: string example: octocat/Hello-World description: The full, globally unique name of the repository. html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: The URL to view the repository on GitHub.com. node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 description: The GraphQL identifier of the repository. private: type: boolean description: Whether the repository is private. default_branch: type: string example: main description: The default branch for the repository. required: - id - full_name - html_url - node_id - private - default_branch simple-classroom-organization: title: Organization Simple for Classroom description: A GitHub organization. type: object properties: id: type: integer example: 1 login: type: string example: github node_id: type: string example: MDEyOk9yZ2FuaXphdGlvbjE= html_url: type: string format: uri example: https://github.com/github name: type: string example: Github - Code thigns happen here nullable: true avatar_url: type: string example: https://github.com/images/error/octocat_happy.gif required: - id - login - node_id - html_url - name - avatar_url classroom: title: Classroom description: A GitHub Classroom classroom type: object properties: id: description: Unique identifier of the classroom. example: 42 type: integer name: description: The name of the classroom. type: string example: Programming Elixir archived: description: Whether classroom is archived. type: boolean example: false organization: "$ref": "#/components/schemas/simple-classroom-organization" url: description: The URL of the classroom on GitHub Classroom. type: string example: https://classroom.github.com/classrooms/1-programming-elixir required: - id - name - archived - organization - url classroom-assignment: title: Classroom Assignment description: A GitHub Classroom assignment type: object properties: id: description: Unique identifier of the repository. type: integer example: 42 public_repo: description: Whether an accepted assignment creates a public repository. type: boolean example: true title: description: Assignment title. type: string example: Intro to Binaries type: description: Whether it's a group assignment or individual assignment. type: string example: individual enum: - individual - group invite_link: description: The link that a student can use to accept the assignment. type: string example: https://classroom.github.com/a/Lx7jiUgx invitations_enabled: description: Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. type: boolean example: true slug: description: Sluggified name of the assignment. type: string example: intro-to-binaries students_are_repo_admins: description: Whether students are admins on created repository when a student accepts the assignment. type: boolean example: true feedback_pull_requests_enabled: description: Whether feedback pull request will be created when a student accepts the assignment. type: boolean example: true max_teams: description: The maximum allowable teams for the assignment. nullable: true type: integer example: 0 max_members: description: The maximum allowable members per team. nullable: true type: integer example: 0 editor: description: The selected editor for the assignment. type: string example: codespaces accepted: description: The number of students that have accepted the assignment. type: integer example: 25 submitted: description: The number of students that have submitted the assignment. type: integer example: 10 passing: description: The number of students that have passed the assignment. type: integer example: 10 language: description: The programming language used in the assignment. type: string example: elixir deadline: description: The time at which the assignment is due. type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true starter_code_repository: "$ref": "#/components/schemas/simple-classroom-repository" classroom: "$ref": "#/components/schemas/classroom" required: - id - public_repo - title - type - invite_link - invitations_enabled - slug - students_are_repo_admins - feedback_pull_requests_enabled - max_teams - max_members - editor - accepted - submitted - passing - language - deadline - starter_code_repository - classroom simple-classroom-user: title: Simple Classroom User description: A GitHub user simplified for Classroom. type: object properties: id: type: integer example: 1 login: type: string example: octocat avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif html_url: type: string format: uri example: https://github.com/octocat required: - id - login - avatar_url - html_url simple-classroom: title: Simple Classroom description: A GitHub Classroom classroom type: object properties: id: description: Unique identifier of the classroom. example: 42 type: integer name: description: The name of the classroom. type: string example: Programming Elixir archived: description: Returns whether classroom is archived or not. type: boolean example: false url: description: The url of the classroom on GitHub Classroom. type: string example: https://classroom.github.com/classrooms/1-programming-elixir required: - id - name - archived - url simple-classroom-assignment: title: Simple Classroom Assignment description: A GitHub Classroom assignment type: object properties: id: description: Unique identifier of the repository. type: integer example: 42 public_repo: description: Whether an accepted assignment creates a public repository. type: boolean example: true title: description: Assignment title. type: string example: Intro to Binaries type: description: Whether it's a Group Assignment or Individual Assignment. type: string example: individual enum: - individual - group invite_link: description: The link that a student can use to accept the assignment. type: string example: https://classroom.github.com/a/Lx7jiUgx invitations_enabled: description: Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. type: boolean example: true slug: description: Sluggified name of the assignment. type: string example: intro-to-binaries students_are_repo_admins: description: Whether students are admins on created repository on accepted assignment. type: boolean example: true feedback_pull_requests_enabled: description: Whether feedback pull request will be created on assignment acceptance. type: boolean example: true max_teams: description: The maximum allowable teams for the assignment. nullable: true type: integer example: 0 max_members: description: The maximum allowable members per team. nullable: true type: integer example: 0 editor: description: The selected editor for the assignment. type: string example: codespaces accepted: description: The number of students that have accepted the assignment. type: integer example: 25 submitted: description: The number of students that have submitted the assignment. type: integer example: 10 passing: description: The number of students that have passed the assignment. type: integer example: 10 language: description: The programming language used in the assignment. type: string example: elixir deadline: description: The time at which the assignment is due. type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true classroom: "$ref": "#/components/schemas/simple-classroom" required: - id - public_repo - title - type - invite_link - invitations_enabled - slug - students_are_repo_admins - feedback_pull_requests_enabled - editor - accepted - submitted - passing - language - deadline - classroom classroom-accepted-assignment: title: Classroom Accepted Assignment description: A GitHub Classroom accepted assignment type: object properties: id: description: Unique identifier of the repository. type: integer example: 42 submitted: description: Whether an accepted assignment has been submitted. type: boolean example: true passing: description: Whether a submission passed. type: boolean example: true commit_count: description: Count of student commits. type: integer example: 5 grade: description: Most recent grade. type: string example: 10/10 students: type: array items: "$ref": "#/components/schemas/simple-classroom-user" repository: "$ref": "#/components/schemas/simple-classroom-repository" assignment: "$ref": "#/components/schemas/simple-classroom-assignment" required: - id - submitted - passing - commit_count - grade - students - repository - assignment classroom-assignment-grade: title: Classroom Assignment Grade description: Grade for a student or groups GitHub Classroom assignment type: object properties: assignment_name: description: Name of the assignment type: string assignment_url: description: URL of the assignment type: string starter_code_url: description: URL of the starter code for the assignment type: string github_username: description: GitHub username of the student type: string roster_identifier: description: Roster identifier of the student type: string student_repository_name: description: Name of the student's assignment repository type: string student_repository_url: description: URL of the student's assignment repository type: string submission_timestamp: description: Timestamp of the student's assignment submission type: string points_awarded: description: Number of points awarded to the student type: integer points_available: description: Number of points available for the assignment type: integer group_name: description: If a group assignment, name of the group the student is in type: string required: - assignment_name - assignment_url - starter_code_url - github_username - roster_identifier - student_repository_name - student_repository_url - submission_timestamp - points_awarded - points_available code-of-conduct: title: Code Of Conduct description: Code Of Conduct type: object properties: key: type: string example: contributor_covenant name: type: string example: Contributor Covenant url: type: string format: uri example: https://api.github.com/codes_of_conduct/contributor_covenant body: type: string example: | # Contributor Covenant Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). html_url: type: string format: uri nullable: true required: - url - html_url - key - name server-statistics-actions: type: object description: Actions metrics that are included in the Server Statistics payload/export from GHES properties: number_of_repos_using_actions: description: The total number of repositories in a GHES installation that have Actions enabled type: integer percentage_of_repos_using_actions: description: The percentage of repositories in a GHES installation that have Actions enabled type: string server-statistics-packages: type: object description: Packages metrics that are included in the Server Statistics payload/export from GHES properties: registry_enabled: description: Whether GitHub Packages is enabled globally in a GHES installation type: boolean registry_v2_enabled: description: Whether a beta registry is enabled in a GHES installation type: boolean ecosystems: description: The details of the package ecosystems that are enabled in a GHES installation type: array items: type: object properties: name: description: The name of the package ecosystem type: string enum: - npm - maven - docker - nuget - rubygems - containers enabled: description: Shows if a package system is enabled, disabled, or read-only in a GHES installation type: string enum: - 'TRUE' - 'FALSE' - READONLY published_packages_count: description: The total number of published packages in a package ecosystem in a GHES installation type: integer private_packages_count: description: The total number of private packages in a package ecosystem in a GHES installation type: integer public_packages_count: description: The total number of public packages in a package ecosystem in a GHES installation type: integer internal_packages_count: description: The total number of internal packages in a package ecosystem in a GHES installation type: integer user_packages_count: description: The total number of user packages in a package ecosystem in a GHES installation type: integer organization_packages_count: description: The total number of organization packages in a package ecosystem in a GHES installation type: integer daily_download_count: description: The total number of packages in an ecosystem that have been downloaded in the 24 hours prior to `collection_date` for a GHES installation type: integer daily_update_count: description: The total number of packages in an ecosystem that have been updated in the 24 hours prior to `collection_date` for a GHES installation type: integer daily_delete_count: description: The total number of packages in an ecosystem that have been deleted in the 24 hours prior to `collection_date` for a GHES installation type: integer daily_create_count: description: The total number of packages in an ecosystem that have been created in the 24 hours prior to `collection_date` for a GHES installation type: integer server-statistics: title: Server Statistics Proxy Endpoint description: Response of S4 Proxy endpoint that provides GHES statistics type: array items: type: object properties: server_id: type: string collection_date: type: string schema_version: type: string ghes_version: type: string host_name: type: string github_connect: type: object properties: features_enabled: type: array items: type: string ghe_stats: type: object properties: comments: type: object properties: total_commit_comments: type: integer total_gist_comments: type: integer total_issue_comments: type: integer total_pull_request_comments: type: integer gists: type: object properties: total_gists: type: integer private_gists: type: integer public_gists: type: integer hooks: type: object properties: total_hooks: type: integer active_hooks: type: integer inactive_hooks: type: integer issues: type: object properties: total_issues: type: integer open_issues: type: integer closed_issues: type: integer milestones: type: object properties: total_milestones: type: integer open_milestones: type: integer closed_milestones: type: integer orgs: type: object properties: total_orgs: type: integer disabled_orgs: type: integer total_teams: type: integer total_team_members: type: integer pages: type: object properties: total_pages: type: integer pulls: type: object properties: total_pulls: type: integer merged_pulls: type: integer mergeable_pulls: type: integer unmergeable_pulls: type: integer repos: type: object properties: total_repos: type: integer root_repos: type: integer fork_repos: type: integer org_repos: type: integer total_pushes: type: integer total_wikis: type: integer users: type: object properties: total_users: type: integer admin_users: type: integer suspended_users: type: integer dormant_users: type: object properties: total_dormant_users: type: integer dormancy_threshold: type: string actions_stats: "$ref": "#/components/schemas/server-statistics-actions" packages_stats: "$ref": "#/components/schemas/server-statistics-packages" enterprise-access-restrictions: type: object title: Enterprise Access Restrictions description: Information about the enterprise access restrictions proxy header. properties: message: type: string description: The message returned for the request. header_name: type: string description: The name of the proxy header. example: sec-GitHub-allowed-enterprise header_value: type: string description: The value of the proxy header. required: - message - header_name - header_value actions-cache-usage-org-enterprise: type: object properties: total_active_caches_count: type: integer description: The count of active caches across all repositories of an enterprise or an organization. total_active_caches_size_in_bytes: type: integer description: The total size in bytes of all active cache items across all repositories of an enterprise or an organization. required: - total_active_caches_count - total_active_caches_size_in_bytes nullable-actions-hosted-runner-pool-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object properties: id: description: The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. type: string example: ubuntu-20.04 size_gb: description: Image size in GB. type: integer example: 86 display_name: description: Display name for this image. type: string example: 20.04 source: description: The image provider. type: string enum: - github - partner - custom version: description: The image version of the hosted runner pool. type: string example: latest required: - id - size_gb - display_name - source nullable: true actions-hosted-runner-machine-spec: title: Github-owned VM details. description: Provides details of a particular machine spec. type: object properties: id: description: The ID used for the `size` parameter when creating a new runner. type: string example: 8-core cpu_cores: description: The number of cores. type: integer example: 8 memory_gb: description: The available RAM for the machine spec. type: integer example: 32 storage_gb: description: The available SSD storage for the machine spec. type: integer example: 300 required: - id - cpu_cores - memory_gb - storage_gb public-ip: title: Public IP for a GitHub-hosted larger runners. description: Provides details of Public IP for a GitHub-hosted larger runners type: object properties: enabled: description: Whether public IP is enabled. type: boolean example: true prefix: description: The prefix for the public IP. type: string example: 20.80.208.150 length: description: The length of the IP prefix. type: integer example: 28 actions-hosted-runner: title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object properties: id: description: The unique identifier of the hosted runner. type: integer example: 5 name: description: The name of the hosted runner. type: string example: my-github-hosted-runner runner_group_id: description: The unique identifier of the group that the hosted runner belongs to. type: integer example: 2 image_details: "$ref": "#/components/schemas/nullable-actions-hosted-runner-pool-image" machine_size_details: "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" status: description: The status of the runner. type: string example: Ready enum: - Ready - Provisioning - Shutdown - Deleting - Stuck platform: description: The operating system of the image. type: string example: linux-x64 maximum_runners: description: The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. type: integer default: 10 example: 5 public_ip_enabled: description: Whether public IP is enabled for the hosted runners. type: boolean example: true public_ips: description: The public IP ranges when public IP is enabled for the hosted runners. type: array items: "$ref": "#/components/schemas/public-ip" last_active_on: description: The time at which the runner was last used, in ISO 8601 format. type: string format: date-time example: '2022-10-09T23:39:01Z' nullable: true image_gen: type: boolean description: Whether custom image generation is enabled for the hosted runners. required: - id - name - image_details - machine_size_details - status - public_ip_enabled - platform actions-hosted-runner-custom-image: title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object properties: id: description: The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. type: integer example: 1 platform: description: The operating system of the image. type: string example: linux-x64 total_versions_size: description: Total size of all the image versions in GB. type: integer example: 200 name: description: Display name for this image. type: string example: CustomImage source: description: The image provider. type: string example: custom versions_count: description: The number of image versions associated with the image. type: integer example: 4 latest_version: description: The latest image version associated with the image. type: string example: 1.3.0 state: description: The number of image versions associated with the image. type: string example: Ready required: - id - platform - name - source - versions_count - total_versions_size - latest_version - state actions-hosted-runner-custom-image-version: title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version type: object properties: version: description: The version of image. type: string example: 1.0.0 state: description: The state of image version. type: string example: Ready size_gb: description: Image version size in GB. type: integer example: 30 created_on: description: The creation date time of the image version. type: string example: '2024-11-09T23:39:01Z' state_details: description: The image version status details. type: string example: None required: - version - state - size_gb - created_on - state_details actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object properties: id: description: The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. type: string example: ubuntu-20.04 platform: description: The operating system of the image. type: string example: linux-x64 size_gb: description: Image size in GB. type: integer example: 86 display_name: description: Display name for this image. type: string example: 20.04 source: description: The image provider. type: string enum: - github - partner - custom required: - id - platform - size_gb - display_name - source actions-hosted-runner-limits: type: object properties: public_ips: title: Static public IP Limits for GitHub-hosted Hosted Runners. description: Provides details of static public IP limits for GitHub-hosted Hosted Runners type: object properties: maximum: type: integer description: The maximum number of static public IP addresses that can be used for Hosted Runners. example: 50 current_usage: type: integer description: The current number of static public IP addresses in use by Hosted Runners. example: 17 required: - maximum - current_usage required: - public_ips actions-oidc-custom-issuer-policy-for-enterprise: type: object properties: include_enterprise_slug: description: Whether the enterprise customer requested a custom issuer URL. type: boolean example: true enabled-organizations: type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. enum: - all - none - selected allowed-actions: type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. enum: - all - local_only - selected selected-actions-url: type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. sha-pinning-required: type: boolean description: Whether actions must be pinned to a full-length commit SHA. actions-enterprise-permissions: type: object properties: enabled_organizations: "$ref": "#/components/schemas/enabled-organizations" selected_organizations_url: type: string description: The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. allowed_actions: "$ref": "#/components/schemas/allowed-actions" selected_actions_url: "$ref": "#/components/schemas/selected-actions-url" sha_pinning_required: "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_organizations actions-artifact-and-log-retention-response: type: object properties: days: type: integer description: The number of days artifacts and logs are retained maximum_allowed_days: type: integer description: The maximum number of days that can be configured required: - days - maximum_allowed_days actions-artifact-and-log-retention: type: object properties: days: type: integer description: The number of days to retain artifacts and logs required: - days actions-fork-pr-contributor-approval: type: object properties: approval_policy: type: string enum: - first_time_contributors_new_to_github - first_time_contributors - all_external_contributors description: The policy that controls when fork PR workflows require approval from a maintainer. required: - approval_policy actions-fork-pr-workflows-private-repos: type: object required: - run_workflows_from_fork_pull_requests - send_write_tokens_to_workflows - send_secrets_and_variables - require_approval_for_fork_pr_workflows properties: run_workflows_from_fork_pull_requests: type: boolean description: Whether workflows triggered by pull requests from forks are allowed to run on private repositories. send_write_tokens_to_workflows: type: boolean description: Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. send_secrets_and_variables: type: boolean description: Whether to make secrets and variables available to workflows triggered by pull requests from forks. require_approval_for_fork_pr_workflows: type: boolean description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. actions-fork-pr-workflows-private-repos-request: type: object required: - run_workflows_from_fork_pull_requests properties: run_workflows_from_fork_pull_requests: type: boolean description: Whether workflows triggered by pull requests from forks are allowed to run on private repositories. send_write_tokens_to_workflows: type: boolean description: Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. send_secrets_and_variables: type: boolean description: Whether to make secrets and variables available to workflows triggered by pull requests from forks. require_approval_for_fork_pr_workflows: type: boolean description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. organization-simple: title: Organization Simple description: A GitHub organization. type: object properties: login: type: string example: github id: type: integer example: 1 node_id: type: string example: MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri example: https://api.github.com/orgs/github repos_url: type: string format: uri example: https://api.github.com/orgs/github/repos events_url: type: string format: uri example: https://api.github.com/orgs/github/events hooks_url: type: string example: https://api.github.com/orgs/github/hooks issues_url: type: string example: https://api.github.com/orgs/github/issues members_url: type: string example: https://api.github.com/orgs/github/members{/member} public_members_url: type: string example: https://api.github.com/orgs/github/public_members{/member} avatar_url: type: string example: https://github.com/images/error/octocat_happy.gif description: type: string example: A great organization nullable: true required: - login - url - id - node_id - repos_url - events_url - hooks_url - issues_url - members_url - public_members_url - avatar_url - description selected-actions: type: object properties: github_owned_allowed: type: boolean description: Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. verified_allowed: type: boolean description: Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. patterns_allowed: type: array description: Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. items: type: string actions-default-workflow-permissions: type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write actions-can-approve-pull-request-reviews: type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. actions-get-default-workflow-permissions: type: object properties: default_workflow_permissions: "$ref": "#/components/schemas/actions-default-workflow-permissions" can_approve_pull_request_reviews: "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" required: - default_workflow_permissions - can_approve_pull_request_reviews actions-set-default-workflow-permissions: type: object properties: default_workflow_permissions: "$ref": "#/components/schemas/actions-default-workflow-permissions" can_approve_pull_request_reviews: "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" runner-groups-enterprise: type: object properties: id: type: number name: type: string visibility: type: string default: type: boolean selected_organizations_url: type: string runners_url: type: string hosted_runners_url: type: string network_configuration_id: description: The identifier of a hosted compute network configuration. type: string allows_public_repositories: type: boolean workflow_restrictions_read_only: description: If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main required: - id - name - visibility - allows_public_repositories - default - runners_url runner-label: title: Self hosted runner label description: A label for a self hosted runner type: object properties: id: type: integer description: Unique identifier of the label. name: type: string description: Name of the label. type: type: string description: The type of label. Read-only labels are applied automatically when the runner is configured. enum: - read-only - custom required: - name runner: title: Self hosted runners description: A self hosted runner type: object properties: id: description: The ID of the runner. type: integer example: 5 runner_group_id: description: The ID of the runner group. type: integer example: 1 name: description: The name of the runner. type: string example: iMac os: description: The Operating System of the runner. type: string example: macos status: description: The status of the runner. type: string example: online busy: type: boolean labels: type: array items: "$ref": "#/components/schemas/runner-label" ephemeral: type: boolean required: - id - name - os - status - busy - labels runner-application: title: Runner Application description: Runner Application type: object properties: os: type: string architecture: type: string download_url: type: string filename: type: string temp_download_token: description: A short lived bearer token used to download the runner, if needed. type: string sha256_checksum: type: string required: - os - architecture - download_url - filename authentication-token: title: Authentication Token description: Authentication Token type: object properties: token: description: The token used for authentication type: string example: v1.1f699f1069f60xxx expires_at: description: The time this token expires type: string format: date-time example: '2016-07-11T22:14:10Z' permissions: type: object example: issues: read deployments: write repositories: description: The repositories this token has access to type: array items: "$ref": "#/components/schemas/repository" single_file: type: string example: config.yaml nullable: true repository_selection: description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected required: - token - expires_at announcement-message: type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true announcement-expiration: type: string format: date-time description: 'The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true announcement-user-dismissible: type: boolean description: Whether an announcement can be dismissed by the user. example: false nullable: true default: false announcement-banner: title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: announcement: "$ref": "#/components/schemas/announcement-message" expires_at: "$ref": "#/components/schemas/announcement-expiration" user_dismissible: "$ref": "#/components/schemas/announcement-user-dismissible" required: - announcement - expires_at - user_dismissible announcement: title: Enterprise Announcement description: Enterprise global announcement type: object properties: announcement: "$ref": "#/components/schemas/announcement-message" expires_at: "$ref": "#/components/schemas/announcement-expiration" user_dismissible: "$ref": "#/components/schemas/announcement-user-dismissible" required: - announcement installable-organization: title: Installable Organization description: A GitHub organization on which a GitHub App can be installed. type: object properties: id: type: integer example: 1 login: type: string example: github accessible_repositories_url: type: string format: uri example: https://api.github.com/enterprises/biz-name/apps/organizations/org-login/accessible_repositories required: - id - login accessible-repository: title: Accessible Repository description: A repository that may be made accessible to a GitHub App. type: object properties: id: description: Unique identifier of the repository type: integer format: int64 example: 1 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World required: - full_name - id - name enterprise-organization-installation: title: Enterprise Organization Installation description: A GitHub App Installation on an enterprise-owned organization type: object properties: id: description: The ID of the installation. type: integer example: 1 app_slug: type: string example: github/github-actions client_id: type: string example: Iv1.ab1112223334445c repository_selection: description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected repositories_url: type: string format: uri example: https://api.github.com/enterprises/acme-corp/apps/organizations/some-org/installations/1/repositories permissions: "$ref": "#/components/schemas/app-permissions" events: type: array items: type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - client_id - repository_selection - repositories_url - permissions - created_at - updated_at audit-log-event: type: object properties: "@timestamp": type: integer description: The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). action: type: string description: The name of the action that was performed, for example `user.login` or `repo.create`. active: type: boolean active_was: type: boolean actor: type: string description: The actor who performed the action. actor_id: type: integer description: The id of the actor who performed the action. actor_location: type: object properties: country_name: type: string data: type: object additionalProperties: true org_id: type: integer user_id: type: integer business_id: type: integer blocked_user: type: string description: The username of the account being blocked. business: type: string config: type: array items: type: object config_was: type: array items: type: object content_type: type: string operation_type: type: string created_at: type: integer description: The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). deploy_key_fingerprint: type: string _document_id: type: string description: A unique identifier for an audit event. emoji: type: string events: type: array items: type: object events_were: type: array items: type: object explanation: type: string fingerprint: type: string hook_id: type: integer limited_availability: type: boolean message: type: string name: type: string old_user: type: string openssh_public_key: type: string org: type: string previous_visibility: type: string read_only: type: boolean repo: type: string description: The name of the repository. repository: type: string description: The name of the repository. repository_public: type: boolean target_login: type: string team: type: string transport_protocol: type: integer description: The type of protocol (for example, HTTP or SSH) used to transfer Git data. transport_protocol_name: type: string description: A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. user: type: string description: The user that was affected by the action performed (if available). visibility: type: string description: The repository visibility, for example `public` or `private`. audit-log-stream-key: title: stream-key description: Audit Log Streaming Public Key type: object properties: key_id: type: string key: type: string required: - key_id - key get-audit-log-stream-configs: title: List audit log streaming configurations description: Lists the audit log streaming configurations for an enterprise. type: array items: type: object properties: id: type: integer stream_type: type: string stream_details: type: string enabled: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time paused_at: type: string nullable: true format: date-time required: - id - stream_type - stream_details - enabled - created_at - updated_at azure-blob-config: title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object properties: key_id: type: string description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. encrypted_sas_url: type: string container: type: string description: The name of the Azure Blob Storage container to which the audit logs will be sent. required: - key_id - encrypted_sas_url - container azure-hub-config: title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object properties: name: type: string description: Instance name of Azure Event Hubs encrypted_connstring: type: string description: Encrypted Connection String for Azure Event Hubs key_id: type: string description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. required: - name - encrypted_connstring - key_id amazon-s3-oidc-config: title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object properties: bucket: type: string description: Amazon S3 Bucket Name. region: type: string description: AWS S3 Bucket Region. key_id: type: string description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. authentication_type: type: string description: Authentication Type for Amazon S3. enum: - oidc arn_role: type: string required: - arn_role - authentication_type - bucket - key_id - region amazon-s3-access-keys-config: title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. type: object properties: bucket: type: string description: Amazon S3 Bucket Name. region: type: string description: Amazon S3 Bucket Name. key_id: type: string description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. authentication_type: type: string description: Authentication Type for Amazon S3. enum: - access_keys encrypted_secret_key: type: string description: Encrypted AWS Secret Key. encrypted_access_key_id: type: string description: Encrypted AWS Access Key ID. required: - authentication_type - bucket - encrypted_access_key_id - encrypted_secret_key - key_id - region splunk-config: title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object properties: domain: description: Domain of Splunk instance. type: string port: description: The port number for connecting to Splunk. type: integer key_id: type: string description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. encrypted_token: description: Encrypted Token. type: string ssl_verify: description: SSL verification helps ensure your events are sent to your Splunk endpoint securely. type: boolean required: - domain - encrypted_token - key_id - port - ssl_verify hec-config: title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object properties: domain: description: Domain of Hec instance. type: string port: description: The port number for connecting to HEC. type: integer key_id: type: string description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. encrypted_token: description: Encrypted Token. type: string path: description: Path to send events to. type: string ssl_verify: description: SSL verification helps ensure your events are sent to your HEC endpoint securely. type: boolean required: - domain - encrypted_token - path - key_id - port - ssl_verify google-cloud-config: title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object properties: bucket: type: string description: Google Cloud Bucket Name key_id: type: string description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. encrypted_json_credentials: type: string required: - bucket - key_id - encrypted_json_credentials datadog-config: title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object properties: encrypted_token: description: Encrypted Splunk token. type: string site: description: Datadog Site to use. type: string enum: - US - US3 - US5 - EU1 - US1-FED - AP1 key_id: description: Key ID obtained from the audit log stream key endpoint used to encrypt secrets. type: string required: - encrypted_token - site - key_id get-audit-log-stream-config: title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object properties: id: type: integer stream_type: type: string stream_details: type: string enabled: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time paused_at: type: string nullable: true format: date-time required: - id - stream_type - stream_details - enabled - created_at - updated_at bypass-response: title: Bypass response description: A response made by a delegated bypasser to a bypass request. type: object properties: id: type: integer description: The ID of the response to the bypass request. reviewer: type: object description: The user who reviewed the bypass request. properties: actor_id: type: integer description: The ID of the GitHub user who reviewed the bypass request. actor_name: type: string description: The name of the GitHub user who reviewed the bypass request. status: type: string description: The response status to the bypass request until dismissed. enum: - approved - denied - dismissed created_at: type: string format: date-time description: The date and time the response to the bypass request was created. push-rule-bypass-request: title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. type: object properties: id: type: integer description: The unique identifier of the bypass request. number: type: integer description: The number uniquely identifying the bypass request within its repository. repository: type: object description: The repository the bypass request is for. properties: id: type: integer description: The ID of the repository the bypass request is for. nullable: true name: type: string description: The name of the repository the bypass request is for. nullable: true full_name: type: string description: The full name of the repository the bypass request is for. nullable: true organization: type: object description: The organization associated with the repository the bypass request is for. properties: id: type: integer description: The ID of the organization. nullable: true name: type: string description: The name of the organization. nullable: true requester: type: object description: The user who requested the bypass. properties: actor_id: type: integer description: The ID of the GitHub user who requested the bypass. actor_name: type: string description: The name of the GitHub user who requested the bypass. request_type: type: string description: The type of request. data: nullable: true type: array description: Data describing the push rules that are being requested to be bypassed. items: type: object properties: ruleset_id: type: integer description: The ID of the ruleset for the rules that were violated. ruleset_name: type: string description: The name of the ruleset for the rules that were violated. total_violations: type: integer description: The number of rule violations generated from the push associated with this request. rule_type: type: string description: The type of rule that was violated. resource_identifier: type: string description: The unique identifier for the request type of the bypass request. For example, a commit SHA. example: 827efc6d56897b048c772eb4087f854f46256132 status: type: string description: The status of the bypass request. enum: - pending - denied - approved - cancelled - completed - expired - deleted - open requester_comment: type: string description: The comment the requester provided when creating the bypass request. nullable: true expires_at: type: string format: date-time description: The date and time the bypass request will expire. created_at: type: string format: date-time description: The date and time the bypass request was created. responses: type: array description: The responses to the bypass request. nullable: true items: "$ref": "#/components/schemas/bypass-response" url: type: string format: uri example: https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1 html_url: type: string description: The URL to view the bypass request in a browser. format: uri example: https://github.com/octo-org/smile/exemptions/1 secret-scanning-bypass-request: title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. type: object properties: id: type: integer description: The unique identifier of the bypass request. number: type: integer description: The number uniquely identifying the bypass request within its repository. repository: type: object description: The repository the bypass request is for. properties: id: type: integer description: The ID of the repository the bypass request is for. name: type: string description: The name of the repository the bypass request is for. full_name: type: string description: The full name of the repository the bypass request is for. organization: type: object description: The organization associated with the repository the bypass request is for. properties: id: type: integer description: The ID of the organization. name: type: string description: The name of the organization. requester: type: object description: The user who requested the bypass. properties: actor_id: type: integer description: The ID of the GitHub user who requested the bypass. actor_name: type: string description: The name of the GitHub user who requested the bypass. request_type: type: string description: The type of request. data: nullable: true type: array description: Data describing the push rules that are being requested to be bypassed. items: type: object properties: secret_type: type: string description: The type of secret that secret scanning detected. bypass_reason: type: string enum: - used_in_tests - false_positive - fix_later description: The reason the bypass was requested. path: type: string description: The path in the repo where the secret was located during the request. branch: type: string description: The branch in the repo where the secret was located during the request. resource_identifier: type: string description: The unique identifier for the request type of the bypass request. For example, a commit SHA. example: 827efc6d56897b048c772eb4087f854f46256132 status: type: string description: The status of the bypass request. enum: - pending - denied - approved - cancelled - completed - expired - open requester_comment: type: string description: The comment the requester provided when creating the bypass request. nullable: true expires_at: type: string format: date-time description: The date and time the bypass request will expire. created_at: type: string format: date-time description: The date and time the bypass request was created. responses: type: array description: The responses to the bypass request. nullable: true items: "$ref": "#/components/schemas/bypass-response" url: type: string format: uri example: https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1 html_url: type: string description: The URL to view the bypass request in a browser. format: uri example: https://github.com/octo-org/smile/exemptions/1 code-scanning-analysis-tool-name: type: string description: The name of the tool used to generate the code scanning analysis. code-scanning-analysis-tool-guid: nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. code-scanning-alert-state-query: type: string description: State of a code scanning alert. enum: - open - closed - dismissed - fixed alert-number: type: integer description: The security alert number. readOnly: true alert-created-at: type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true alert-updated-at: type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true alert-url: type: string description: The REST API URL of the alert resource. format: uri readOnly: true alert-html-url: type: string description: The GitHub URL of the alert resource. format: uri readOnly: true alert-instances-url: type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true code-scanning-alert-state: type: string description: State of a code scanning alert. nullable: true enum: - open - dismissed - fixed alert-fixed-at: type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true alert-dismissed-at: type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true code-scanning-alert-dismissed-reason: type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." nullable: true enum: - false positive - won't fix - used in tests code-scanning-alert-dismissed-comment: type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 code-scanning-alert-rule-summary: type: object properties: id: nullable: true type: string description: A unique identifier for the rule used to detect the alert. name: type: string description: The name of the rule used to detect the alert. severity: nullable: true type: string description: The severity of the alert. enum: - none - note - warning - error security_severity_level: nullable: true type: string description: The security severity of the alert. enum: - low - medium - high - critical description: type: string description: A short description of the rule used to detect the alert. full_description: type: string description: A description of the rule used to detect the alert. tags: nullable: true type: array description: A set of tags applicable for the rule. items: type: string help: nullable: true type: string description: Detailed documentation for the rule as GitHub Flavored Markdown. help_uri: nullable: true type: string description: A link to the documentation for the rule used to detect the alert. code-scanning-analysis-tool-version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. code-scanning-analysis-tool: type: object properties: name: "$ref": "#/components/schemas/code-scanning-analysis-tool-name" version: "$ref": "#/components/schemas/code-scanning-analysis-tool-version" guid: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" code-scanning-ref: type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. code-scanning-analysis-analysis-key: type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. code-scanning-alert-environment: type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. code-scanning-analysis-category: type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. code-scanning-alert-location: type: object description: Describe a region within a file for the alert. properties: path: type: string start_line: type: integer end_line: type: integer start_column: type: integer end_column: type: integer code-scanning-alert-classification: type: string description: A classification of the file. For example to identify it as generated. nullable: true enum: - source - generated - test - library code-scanning-alert-instance: type: object properties: ref: "$ref": "#/components/schemas/code-scanning-ref" analysis_key: "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" environment: "$ref": "#/components/schemas/code-scanning-alert-environment" category: "$ref": "#/components/schemas/code-scanning-analysis-category" state: "$ref": "#/components/schemas/code-scanning-alert-state" commit_sha: type: string message: type: object properties: text: type: string location: "$ref": "#/components/schemas/code-scanning-alert-location" html_url: type: string classifications: type: array description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. items: "$ref": "#/components/schemas/code-scanning-alert-classification" simple-repository: title: Simple Repository description: A GitHub repository. type: object properties: id: type: integer format: int64 example: 1296269 description: A unique identifier of the repository. node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 description: The GraphQL identifier of the repository. name: type: string example: Hello-World description: The name of the repository. full_name: type: string example: octocat/Hello-World description: The full, globally unique, name of the repository. owner: "$ref": "#/components/schemas/simple-user" private: type: boolean description: Whether the repository is private. html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: The URL to view the repository on GitHub.com. description: type: string example: This your first repo! nullable: true description: The repository description. fork: type: boolean description: Whether the repository is a fork. url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World description: The URL to get more information about the repository from the GitHub API. archive_url: type: string example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} description: A template for the API URL to download the repository as an archive. assignees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} description: A template for the API URL to list the available assignees for issues in the repository. blobs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} description: A template for the API URL to create or retrieve a raw Git blob in the repository. branches_url: type: string example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} description: A template for the API URL to get information about branches in the repository. collaborators_url: type: string example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} description: A template for the API URL to get information about collaborators of the repository. comments_url: type: string example: https://api.github.com/repos/octocat/Hello-World/comments{/number} description: A template for the API URL to get information about comments on the repository. commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} description: A template for the API URL to get information about commits on the repository. compare_url: type: string example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} description: A template for the API URL to compare two commits or refs. contents_url: type: string example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} description: A template for the API URL to get the contents of the repository. contributors_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/contributors description: A template for the API URL to list the contributors to the repository. deployments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/deployments description: The API URL to list the deployments of the repository. downloads_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/downloads description: The API URL to list the downloads on the repository. events_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/events description: The API URL to list the events of the repository. forks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/forks description: The API URL to list the forks of the repository. git_commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} description: A template for the API URL to get information about Git commits of the repository. git_refs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} description: A template for the API URL to get information about Git refs of the repository. git_tags_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} description: A template for the API URL to get information about Git tags of the repository. issue_comment_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} description: A template for the API URL to get information about issue comments on the repository. issue_events_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} description: A template for the API URL to get information about issue events on the repository. issues_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues{/number} description: A template for the API URL to get information about issues on the repository. keys_url: type: string example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} description: A template for the API URL to get information about deploy keys on the repository. labels_url: type: string example: https://api.github.com/repos/octocat/Hello-World/labels{/name} description: A template for the API URL to get information about labels of the repository. languages_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/languages description: The API URL to get information about the languages of the repository. merges_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/merges description: The API URL to merge branches in the repository. milestones_url: type: string example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} description: A template for the API URL to get information about milestones of the repository. notifications_url: type: string example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} description: A template for the API URL to get information about notifications on the repository. pulls_url: type: string example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} description: A template for the API URL to get information about pull requests on the repository. releases_url: type: string example: https://api.github.com/repos/octocat/Hello-World/releases{/id} description: A template for the API URL to get information about releases on the repository. stargazers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/stargazers description: The API URL to list the stargazers on the repository. statuses_url: type: string example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} description: A template for the API URL to get information about statuses of a commit. subscribers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscribers description: The API URL to list the subscribers on the repository. subscription_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscription description: The API URL to subscribe to notifications for this repository. tags_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/tags description: The API URL to get information about tags on the repository. teams_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/teams description: The API URL to list the teams on the repository. trees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} description: A template for the API URL to create or retrieve a raw Git tree of the repository. hooks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url code-scanning-organization-alert-items: type: object properties: number: "$ref": "#/components/schemas/alert-number" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/alert-updated-at" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" instances_url: "$ref": "#/components/schemas/alert-instances-url" state: "$ref": "#/components/schemas/code-scanning-alert-state" fixed_at: "$ref": "#/components/schemas/alert-fixed-at" dismissed_by: "$ref": "#/components/schemas/nullable-simple-user" dismissed_at: "$ref": "#/components/schemas/alert-dismissed-at" dismissed_reason: "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" rule: "$ref": "#/components/schemas/code-scanning-alert-rule-summary" tool: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: "$ref": "#/components/schemas/code-scanning-alert-instance" repository: "$ref": "#/components/schemas/simple-repository" dismissal_approved_by: "$ref": "#/components/schemas/nullable-simple-user" assignees: type: array items: "$ref": "#/components/schemas/simple-user" required: - number - created_at - url - html_url - instances_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool - most_recent_instance - repository code-security-configuration: type: object description: A code security configuration properties: id: type: integer description: The ID of the code security configuration name: type: string description: The name of the code security configuration. Must be unique within the organization. target_type: type: string description: The type of the code security configuration. enum: - global - organization - enterprise description: type: string description: A description of the code security configuration advanced_security: type: string description: The enablement status of GitHub Advanced Security enum: - enabled - disabled - code_security - secret_protection dependency_graph: type: string description: The enablement status of Dependency Graph enum: - enabled - disabled - not_set dependency_graph_autosubmit_action: type: string description: The enablement status of Automatic dependency submission enum: - enabled - disabled - not_set dependency_graph_autosubmit_action_options: type: object description: Feature options for Automatic dependency submission properties: labeled_runners: type: boolean description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. dependabot_alerts: type: string description: The enablement status of Dependabot alerts enum: - enabled - disabled - not_set dependabot_security_updates: type: string description: The enablement status of Dependabot security updates enum: - enabled - disabled - not_set code_scanning_options: type: object description: Feature options for code scanning nullable: true properties: allow_advanced: nullable: true type: boolean description: Whether to allow repos which use advanced setup code_scanning_default_setup: type: string description: The enablement status of code scanning default setup enum: - enabled - disabled - not_set code_scanning_default_setup_options: type: object description: Feature options for code scanning default setup nullable: true properties: runner_type: nullable: true type: string enum: - standard - labeled - not_set description: Whether to use labeled runners or standard GitHub runners. runner_label: nullable: true type: string description: The label of the runner to use for code scanning when runner_type is 'labeled'. code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert dismissal enum: - enabled - disabled - not_set secret_scanning: type: string description: The enablement status of secret scanning enum: - enabled - disabled - not_set secret_scanning_push_protection: type: string description: The enablement status of secret scanning push protection enum: - enabled - disabled - not_set secret_scanning_delegated_bypass: type: string description: The enablement status of secret scanning delegated bypass enum: - enabled - disabled - not_set secret_scanning_delegated_bypass_options: type: object description: Feature options for secret scanning delegated bypass properties: reviewers: type: array description: The bypass reviewers for secret scanning delegated bypass items: type: object required: - reviewer_id - reviewer_type properties: reviewer_id: type: integer description: The ID of the team or role selected as a bypass reviewer reviewer_type: type: string description: The type of the bypass reviewer enum: - TEAM - ROLE secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks enum: - enabled - disabled - not_set secret_scanning_non_provider_patterns: type: string description: The enablement status of secret scanning non-provider patterns enum: - enabled - disabled - not_set secret_scanning_generic_secrets: type: string description: The enablement status of Copilot secret scanning enum: - enabled - disabled - not_set secret_scanning_delegated_alert_dismissal: type: string description: The enablement status of secret scanning delegated alert dismissal enum: - enabled - disabled - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting enum: - enabled - disabled - not_set enforcement: type: string description: The enforcement status for a security configuration enum: - enforced - unenforced url: type: string format: uri description: The URL of the configuration html_url: type: string format: uri description: The URL of the configuration created_at: type: string format: date-time updated_at: type: string format: date-time code-scanning-options: type: object description: Security Configuration feature options for code scanning nullable: true properties: allow_advanced: nullable: true type: boolean description: Whether to allow repos which use advanced setup code-scanning-default-setup-options: type: object description: Feature options for code scanning default setup nullable: true properties: runner_type: type: string enum: - standard - labeled - not_set description: Whether to use labeled runners or standard GitHub runners. runner_label: nullable: true type: string description: The label of the runner to use for code scanning default setup when runner_type is 'labeled'. code-security-default-configurations: type: array description: A list of default code security configurations items: type: object properties: default_for_new_repos: enum: - public - private_and_internal - all description: The visibility of newly created repositories for which the code security configuration will be applied to by default configuration: "$ref": "#/components/schemas/code-security-configuration" code-security-configuration-repositories: type: object description: Repositories associated with a code security configuration and attachment status properties: status: type: string description: The attachment status of the code security configuration on the repository. enum: - attached - attaching - detached - removed - enforced - failed - updating - removed_by_enterprise repository: "$ref": "#/components/schemas/simple-repository" enterprise-security-analysis-settings: title: Enterprise Security Analysis Settings type: object properties: advanced_security_enabled_for_new_repositories: type: boolean example: false description: |- Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to this enterprise. advanced_security_enabled_for_new_user_namespace_repositories: type: boolean example: false description: Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. dependabot_alerts_enabled_for_new_repositories: type: boolean example: false description: |- Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this enterprise. secret_scanning_enabled_for_new_repositories: type: boolean example: false description: |- Whether secret scanning is automatically enabled for new repositories and repositories transferred to this enterprise. secret_scanning_push_protection_enabled_for_new_repositories: type: boolean example: false description: |- Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this enterprise. secret_scanning_push_protection_custom_link: type: string nullable: true example: https://github.com/test-org/test-repo/blob/main/README.md description: An optional URL string to display to contributors who are blocked from pushing a secret. secret_scanning_non_provider_patterns_enabled_for_new_repositories: type: boolean example: false description: Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise. secret_scanning_validity_checks_enabled: type: boolean example: false description: Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise. required: - advanced_security_enabled_for_new_repositories - dependabot_alerts_enabled_for_new_repositories - secret_scanning_enabled_for_new_repositories - secret_scanning_push_protection_enabled_for_new_repositories get-consumed-licenses: title: Enterprise Consumed Licenses description: A breakdown of the licenses consumed by an enterprise. properties: total_seats_consumed: type: integer total_seats_purchased: type: integer users: type: array items: type: object properties: github_com_login: type: string github_com_name: type: string nullable: true enterprise_server_user_ids: type: array items: type: string github_com_user: type: boolean enterprise_server_user: type: boolean nullable: true visual_studio_subscription_user: type: boolean license_type: type: string github_com_profile: type: string nullable: true github_com_member_roles: type: array items: type: string github_com_enterprise_roles: type: array description: All enterprise roles for a user. items: type: string github_com_verified_domain_emails: type: array items: type: string github_com_saml_name_id: type: string nullable: true github_com_orgs_with_pending_invites: type: array items: type: string github_com_two_factor_auth: type: boolean nullable: true enterprise_server_emails: type: array items: type: string visual_studio_license_status: type: string nullable: true visual_studio_subscription_email: type: string nullable: true total_user_accounts: type: integer nullable-organization-simple: title: Organization Simple description: A GitHub organization. type: object properties: login: type: string example: github id: type: integer example: 1 node_id: type: string example: MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri example: https://api.github.com/orgs/github repos_url: type: string format: uri example: https://api.github.com/orgs/github/repos events_url: type: string format: uri example: https://api.github.com/orgs/github/events hooks_url: type: string example: https://api.github.com/orgs/github/hooks issues_url: type: string example: https://api.github.com/orgs/github/issues members_url: type: string example: https://api.github.com/orgs/github/members{/member} public_members_url: type: string example: https://api.github.com/orgs/github/public_members{/member} avatar_url: type: string example: https://github.com/images/error/octocat_happy.gif description: type: string example: A great organization nullable: true required: - login - url - id - node_id - repos_url - events_url - hooks_url - issues_url - members_url - public_members_url - avatar_url - description nullable: true nullable-team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: description: Unique identifier of the team type: integer example: 1 node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team type: string format: uri example: https://api.github.com/organizations/1/team/1 members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} name: description: Name of the team type: string example: Justice League description: description: Description of the team type: string nullable: true example: A great team. permission: description: Permission that the team will have for its repositories type: string example: admin privacy: description: The level of privacy this team should have type: string example: closed notification_setting: description: The notification setting the team has set type: string example: notifications_enabled html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos slug: type: string example: justice-league ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - type nullable: true team: title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: type: integer node_id: type: string name: type: string slug: type: string description: type: string nullable: true privacy: type: string notification_setting: type: string permission: type: string permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - triage - push - maintain - admin url: type: string format: uri html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core members_url: type: string repositories_url: type: string format: uri type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 parent: "$ref": "#/components/schemas/nullable-team-simple" required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - parent - type enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members type: object properties: id: type: integer format: int64 name: type: string description: type: string slug: type: string url: type: string format: uri sync_to_organizations: type: string description: 'Retired: this field will not be returned with GHEC enterprise teams.' example: disabled | all organization_selection_type: type: string example: disabled | selected | all group_id: nullable: true type: string example: 62ab9291-fae2-468e-974b-7e45096d5021 group_name: nullable: true type: string description: 'Retired: this field will not be returned with GHEC enterprise teams.' example: Justice League html_url: type: string format: uri example: https://github.com/enterprises/dc/teams/justice-league members_url: type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - url - members_url - name - html_url - slug - created_at - updated_at - group_id copilot-seat-details: title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. type: object properties: assignee: "$ref": "#/components/schemas/nullable-simple-user" organization: "$ref": "#/components/schemas/nullable-organization-simple" assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - "$ref": "#/components/schemas/team" - "$ref": "#/components/schemas/enterprise-team" nullable: true pending_cancellation_date: type: string format: date nullable: true description: The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. last_activity_at: type: string format: date-time nullable: true description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. last_activity_editor: type: string nullable: true description: Last editor that was used by the user for a GitHub Copilot completion. last_authenticated_at: type: string format: date-time nullable: true description: Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. created_at: type: string format: date-time description: Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. updated_at: type: string format: date-time deprecated: true description: "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." plan_type: type: string description: The Copilot plan of the organization, or the parent enterprise, when applicable. enum: - business - enterprise - unknown required: - created_at additionalProperties: false copilot-ide-code-completions: type: object description: Usage metrics for Copilot editor code completions in the IDE. nullable: true additionalProperties: true properties: total_engaged_users: type: integer description: Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. languages: type: array description: Code completion metrics for active languages. items: type: object description: Usage metrics for a given language for the given editor for Copilot code completions. properties: name: type: string description: Name of the language used for Copilot code completion suggestions. total_engaged_users: type: integer description: Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. editors: type: array items: type: object description: Copilot code completion metrics for active editors. additionalProperties: true properties: name: type: string description: Name of the given editor. total_engaged_users: type: integer description: Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. models: type: array description: List of model metrics for custom models and the default model. items: type: object properties: name: type: string description: Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. custom_model_training_date: type: string nullable: true description: The training date for the custom model. total_engaged_users: type: integer description: Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. languages: type: array description: Code completion metrics for active languages, for the given editor. items: type: object description: Usage metrics for a given language for the given editor for Copilot code completions. properties: name: type: string description: Name of the language used for Copilot code completion suggestions, for the given editor. total_engaged_users: type: integer description: Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. total_code_suggestions: type: integer description: The number of Copilot code suggestions generated for the given editor, for the given language. total_code_acceptances: type: integer description: The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. total_code_lines_suggested: type: integer description: The number of lines of code suggested by Copilot code completions for the given editor, for the given language. total_code_lines_accepted: type: integer description: The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. copilot-ide-chat: type: object description: Usage metrics for Copilot Chat in the IDE. nullable: true additionalProperties: true properties: total_engaged_users: type: integer description: Total number of users who prompted Copilot Chat in the IDE. editors: type: array items: type: object description: Copilot Chat metrics, for active editors. properties: name: type: string description: Name of the given editor. total_engaged_users: type: integer description: The number of users who prompted Copilot Chat in the specified editor. models: type: array description: List of model metrics for custom models and the default model. items: type: object properties: name: type: string description: Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. custom_model_training_date: type: string nullable: true description: The training date for the custom model. total_engaged_users: type: integer description: The number of users who prompted Copilot Chat in the given editor and model. total_chats: type: integer description: The total number of chats initiated by users in the given editor and model. total_chat_insertion_events: type: integer description: The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. total_chat_copy_events: type: integer description: The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. copilot-dotcom-chat: type: object description: Usage metrics for Copilot Chat in GitHub.com nullable: true additionalProperties: true properties: total_engaged_users: type: integer description: Total number of users who prompted Copilot Chat on github.com at least once. models: type: array description: List of model metrics for a custom models and the default model. items: type: object properties: name: type: string description: Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. custom_model_training_date: type: string description: The training date for the custom model (if applicable). nullable: true total_engaged_users: type: integer description: Total number of users who prompted Copilot Chat on github.com at least once for each model. total_chats: type: integer description: Total number of chats initiated by users on github.com. copilot-dotcom-pull-requests: type: object description: Usage metrics for Copilot for pull requests. nullable: true additionalProperties: true properties: total_engaged_users: type: integer description: The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. repositories: type: array description: Repositories in which users used Copilot for Pull Requests to generate pull request summaries items: type: object properties: name: type: string description: Repository name total_engaged_users: type: integer description: The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. models: type: array description: List of model metrics for custom models and the default model. items: type: object properties: name: type: string description: Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. custom_model_training_date: type: string nullable: true description: The training date for the custom model. total_pr_summaries_created: type: integer description: The number of pull request summaries generated using Copilot for Pull Requests in the given repository. total_engaged_users: type: integer description: The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. copilot-usage-metrics-day: title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object properties: date: type: string format: date description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. total_active_users: type: integer description: The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. total_engaged_users: type: integer description: The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. copilot_ide_code_completions: "$ref": "#/components/schemas/copilot-ide-code-completions" copilot_ide_chat: "$ref": "#/components/schemas/copilot-ide-chat" copilot_dotcom_chat: "$ref": "#/components/schemas/copilot-dotcom-chat" copilot_dotcom_pull_requests: "$ref": "#/components/schemas/copilot-dotcom-pull-requests" required: - date additionalProperties: true copilot-usage-metrics-1-day-report: type: object title: Copilot Metrics 1 Day Report description: Links to download the Copilot usage metrics report for an enterprise for a specific day. properties: download_links: type: array items: type: string format: uri description: The URLs to download the Copilot usage metrics report for the enterprise for the specified day. report_day: type: string format: date description: The day of the report in `YYYY-MM-DD` format. required: - download_links - report_day copilot-usage-metrics-28-day-report: type: object title: Copilot Metrics 28 Day Report description: Links to download the latest Copilot usage metrics report for an enterprise. properties: download_links: type: array items: type: string format: uri description: The URLs to download the latest Copilot usage metrics report for the enterprise. report_start_day: type: string format: date description: The start date of the report period in `YYYY-MM-DD` format. report_end_day: type: string format: date description: The end date of the report period in `YYYY-MM-DD` format. required: - download_links - report_start_day - report_end_day dependabot-alert-package: type: object description: Details for the vulnerable package. readOnly: true properties: ecosystem: type: string description: The package's language or package management ecosystem. readOnly: true name: type: string description: The unique package name within its ecosystem. readOnly: true required: - ecosystem - name additionalProperties: false dependabot-alert-security-vulnerability: type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: package: "$ref": "#/components/schemas/dependabot-alert-package" severity: type: string description: The severity of the vulnerability. readOnly: true enum: - low - medium - high - critical vulnerable_version_range: type: string description: Conditions that identify vulnerable versions of this vulnerability's package. readOnly: true first_patched_version: type: object description: Details pertaining to the package version that patches this vulnerability. readOnly: true nullable: true properties: identifier: type: string description: The package version that patches this vulnerability. readOnly: true required: - identifier additionalProperties: false required: - package - severity - vulnerable_version_range - first_patched_version additionalProperties: false dependabot-alert-security-advisory: type: object description: Details for the GitHub Security Advisory. readOnly: true properties: ghsa_id: type: string description: The unique GitHub Security Advisory ID assigned to the advisory. readOnly: true cve_id: type: string description: The unique CVE ID assigned to the advisory. readOnly: true nullable: true summary: type: string description: A short, plain text summary of the advisory. readOnly: true maxLength: 1024 description: type: string description: A long-form Markdown-supported description of the advisory. readOnly: true vulnerabilities: type: array description: Vulnerable version range information for the advisory. readOnly: true items: "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" severity: type: string description: The severity of the advisory. readOnly: true enum: - low - medium - high - critical cvss: type: object description: Details for the advisory pertaining to the Common Vulnerability Scoring System. readOnly: true properties: score: type: number description: The overall CVSS score of the advisory. minimum: 0 maximum: 10 readOnly: true vector_string: type: string description: The full CVSS vector string for the advisory. readOnly: true nullable: true required: - score - vector_string additionalProperties: false cvss_severities: "$ref": "#/components/schemas/cvss-severities" epss: "$ref": "#/components/schemas/security-advisory-epss" cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. readOnly: true items: type: object description: A CWE weakness assigned to the advisory. readOnly: true properties: cwe_id: type: string description: The unique CWE ID. readOnly: true name: type: string description: The short, plain text name of the CWE. readOnly: true required: - cwe_id - name additionalProperties: false identifiers: type: array description: Values that identify this advisory among security information sources. readOnly: true items: type: object description: An advisory identifier. readOnly: true properties: type: type: string description: The type of advisory identifier. readOnly: true enum: - CVE - GHSA value: type: string description: The value of the advisory identifer. readOnly: true required: - value - type additionalProperties: false references: type: array description: Links to additional advisory information. readOnly: true items: type: object description: A link to additional advisory information. readOnly: true properties: url: type: string description: The URL of the reference. format: uri readOnly: true required: - url additionalProperties: false published_at: type: string description: 'The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true updated_at: type: string description: 'The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true withdrawn_at: type: string description: 'The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true required: - ghsa_id - cve_id - summary - description - vulnerabilities - severity - cvss - cwes - identifiers - references - published_at - updated_at - withdrawn_at additionalProperties: false alert-auto-dismissed-at: type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true dependabot-alert-with-repository: type: object description: A Dependabot alert. properties: number: "$ref": "#/components/schemas/alert-number" state: type: string description: The state of the Dependabot alert. readOnly: true enum: - auto_dismissed - dismissed - fixed - open dependency: type: object description: Details for the vulnerable dependency. readOnly: true properties: package: "$ref": "#/components/schemas/dependabot-alert-package" manifest_path: type: string description: The full path to the dependency manifest file, relative to the root of the repository. readOnly: true scope: type: string description: The execution scope of the vulnerable dependency. readOnly: true nullable: true enum: - development - runtime relationship: type: string description: | The vulnerable dependency's relationship to your project. > [!NOTE] > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. readOnly: true nullable: true enum: - unknown - direct - transitive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/alert-updated-at" dismissed_at: "$ref": "#/components/schemas/alert-dismissed-at" dismissed_by: "$ref": "#/components/schemas/nullable-simple-user" dismissed_reason: type: string description: The reason that the alert was dismissed. nullable: true enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk dismissed_comment: type: string description: An optional comment associated with the alert's dismissal. nullable: true maxLength: 280 fixed_at: "$ref": "#/components/schemas/alert-fixed-at" auto_dismissed_at: "$ref": "#/components/schemas/alert-auto-dismissed-at" repository: "$ref": "#/components/schemas/simple-repository" required: - number - state - dependency - security_advisory - security_vulnerability - url - html_url - created_at - updated_at - dismissed_at - dismissed_by - dismissed_reason - dismissed_comment - fixed_at - repository additionalProperties: false nullable-enterprise: title: Enterprise description: An enterprise on GitHub. type: object properties: description: description: A short description of the enterprise. type: string nullable: true html_url: type: string format: uri example: https://github.com/enterprises/octo-business website_url: description: The enterprise's website URL. type: string nullable: true format: uri id: description: Unique identifier of the enterprise example: 42 type: integer node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the enterprise. type: string example: Octo Business slug: description: The slug url identifier for the enterprise. type: string example: octo-business created_at: type: string nullable: true format: date-time example: '2019-01-26T19:01:12Z' updated_at: type: string nullable: true format: date-time example: '2019-01-26T19:14:43Z' avatar_url: type: string format: uri required: - id - node_id - name - slug - html_url - created_at - updated_at - avatar_url nullable: true enterprise-role: title: Enterprise Role description: Enterprise custom roles type: object properties: id: description: The unique identifier of the role. type: integer format: int64 name: description: The name of the role. type: string description: description: A short description about who this role is for or what permissions it grants. type: string nullable: true source: type: string nullable: true description: Source answers the question, "where did this role come from?" enum: - Enterprise - Predefined permissions: description: A list of permissions included in this role. type: array items: type: string enterprise: "$ref": "#/components/schemas/nullable-enterprise" created_at: description: The date and time the role was created. type: string format: date-time updated_at: description: The date and time the role was last updated. type: string format: date-time required: - id - name - permissions - enterprise - created_at - updated_at enterprise-user-role-assignment: title: An Enterprise Role Assignment for a User description: The Relationship a User has with a role in an enterprise context. allOf: - "$ref": "#/components/schemas/simple-user" - type: object properties: assignment: type: string description: Determines if the user has a direct, indirect, or mixed relationship to a role enum: - direct - indirect - mixed example: direct inherited_from: description: Enterprise Team the user has gotten the role through type: array items: "$ref": "#/components/schemas/enterprise-team" get-license-sync-status: title: License Sync Status description: Information about the status of a license sync job for an enterprise. properties: server_instances: type: array items: type: object properties: server_id: type: string hostname: type: string last_sync: type: object properties: date: type: string status: type: string error: type: string network-configuration: title: Hosted compute network configuration description: A hosted compute network configuration. type: object properties: id: description: The unique identifier of the network configuration. type: string example: 123ABC456DEF789 name: description: The name of the network configuration. type: string example: my-network-configuration compute_service: description: The hosted compute service the network configuration supports. type: string enum: - none - actions - codespaces network_settings_ids: description: The unique identifier of each network settings in the configuration. type: array items: type: string example: 123ABC456DEF789 created_on: description: The time at which the network configuration was created, in ISO 8601 format. type: string format: date-time example: '2024-04-26T11:31:07Z' nullable: true required: - id - name - created_on network-settings: title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object properties: id: description: The unique identifier of the network settings resource. type: string example: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: description: The identifier of the network configuration that is using this settings resource. type: string example: 934E208B3EE0BD60CF5F752C426BFB53562 name: description: The name of the network settings resource. type: string example: my-network-settings subnet_id: description: The subnet this network settings resource is configured for. type: string example: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" region: description: The location of the subnet this network settings resource is configured for. type: string example: eastus required: - id - name - subnet_id - region custom-property-base: type: object properties: property_name: type: string description: The name of the property url: type: string format: uri description: The URL that can be used to fetch, update, or delete info about this property via the API. source_type: type: string description: The source type of the property enum: - organization - enterprise example: organization value_type: type: string example: single_select enum: - string - single_select - multi_select - true_false description: The type of the value for the property required: type: boolean description: Whether the property is required. default_value: oneOf: - type: string - type: array items: type: string nullable: true description: Default value of the property description: type: string nullable: true description: Short description of the property allowed_values: type: array items: type: string nullable: true description: |- An ordered list of the allowed values of the property. The property can have up to 200 allowed values. organization-custom-property: title: Custom Property for Organization description: Custom property defined for an organization allOf: - "$ref": "#/components/schemas/custom-property-base" - type: object properties: values_editable_by: type: string nullable: true enum: - enterprise_actors - enterprise_and_org_actors example: enterprise_actors description: Who can edit the values of the property required: - property_name - value_type organization-custom-property-payload: title: Organization Custom Property Payload description: Payload for creating or updating an organization custom property definition on an enterprise. type: object properties: value_type: type: string example: single_select enum: - string - single_select - multi_select - true_false description: The type of the value for the property. required: type: boolean description: Whether the property is required. default_value: oneOf: - type: string - type: array items: type: string nullable: true description: Default value of the property. description: type: string nullable: true description: Short description of the property. allowed_values: type: array items: type: string nullable: true description: |- An ordered list of the allowed values of the property. The property can have up to 200 allowed values. values_editable_by: type: string nullable: true enum: - enterprise_actors - enterprise_and_org_actors example: enterprise_actors description: Who can edit the values of the property. required: - value_type custom-property-value: title: Custom Property Value description: Custom property name and associated value type: object properties: property_name: type: string description: The name of the property value: oneOf: - type: string - type: array items: type: string description: The value assigned to the property nullable: true required: - property_name - value custom-properties-for-orgs-get-enterprise-property-values: title: Enterprise Organization Custom Property Values description: List of custom property values for an organization type: object properties: organization_id: type: integer example: 1296269 organization_login: type: string example: Hello-World properties: type: array items: "$ref": "#/components/schemas/custom-property-value" description: List of custom property names and associated values required: - organization_id - organization_login - properties custom-property: title: Organization Custom Property description: Custom property defined on an organization type: object properties: property_name: type: string description: The name of the property url: type: string format: uri description: The URL that can be used to fetch, update, or delete info about this property via the API. source_type: type: string description: The source type of the property enum: - organization - enterprise example: organization value_type: type: string example: single_select enum: - string - single_select - multi_select - true_false description: The type of the value for the property required: type: boolean description: Whether the property is required. default_value: oneOf: - type: string - type: array items: type: string nullable: true description: Default value of the property description: type: string nullable: true description: Short description of the property allowed_values: type: array items: type: string nullable: true description: |- An ordered list of the allowed values of the property. The property can have up to 200 allowed values. values_editable_by: type: string nullable: true enum: - org_actors - org_and_repo_actors example: org_actors description: Who can edit the values of the property required: - property_name - value_type custom-property-set-payload: title: Custom Property Set Payload description: Custom property set payload type: object properties: value_type: type: string example: single_select enum: - string - single_select - multi_select - true_false description: The type of the value for the property required: type: boolean description: Whether the property is required. default_value: oneOf: - type: string - type: array items: type: string nullable: true description: Default value of the property description: type: string nullable: true description: Short description of the property allowed_values: type: array items: type: string nullable: true description: |- An ordered list of the allowed values of the property. The property can have up to 200 allowed values. values_editable_by: type: string nullable: true enum: - org_actors - org_and_repo_actors example: org_actors description: Who can edit the values of the property required: - value_type repository-rule-enforcement: type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target. enum: - disabled - active - evaluate repository-ruleset-bypass-actor: title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset required: - actor_type properties: actor_id: type: integer nullable: true description: The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories. actor_type: type: string enum: - Integration - OrganizationAdmin - RepositoryRole - Team - DeployKey - EnterpriseOwner description: The type of actor that can bypass a ruleset bypass_mode: type: string description: When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. enum: - always - pull_request - exempt default: always enterprise-ruleset-conditions-organization-name-target: title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition properties: organization_name: type: object properties: include: type: array description: Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts. items: type: string exclude: type: array description: Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match. items: type: string required: - organization_name repository-ruleset-conditions-repository-name-target: title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition properties: repository_name: type: object properties: include: type: array description: Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. items: type: string exclude: type: array description: Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. items: type: string protected: type: boolean description: Whether renaming of target repositories is prevented. required: - repository_name repository-ruleset-conditions: title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition properties: ref_name: type: object properties: include: type: array description: Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. items: type: string exclude: type: array description: Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. items: type: string repository-ruleset-conditions-repository-property-spec: title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository property properties: name: type: string description: The name of the repository property to target property_values: type: array description: The values to match for the repository property items: type: string source: type: string description: The source of the repository property. Defaults to 'custom' if not specified. enum: - custom - system required: - name - property_values repository-ruleset-conditions-repository-property-target: title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition properties: repository_property: type: object properties: include: type: array description: The repository properties and values to include. All of these properties must match for the condition to pass. items: "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" exclude: type: array description: The repository properties and values to exclude. The condition will not pass if any of these properties match. items: "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" required: - repository_property enterprise-ruleset-conditions-organization-id-target: title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition properties: organization_id: type: object properties: organization_ids: type: array description: The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass. items: type: integer required: - organization_id enterprise-ruleset-conditions-organization-property-spec: title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a organization property properties: name: type: string description: The name of the organization property to target property_values: type: array description: The values to match for the organization property items: type: string required: - name - property_values enterprise-ruleset-conditions-organization-property-target: title: Repository ruleset conditions for organization properties type: object description: Parameters for a organization property condition properties: organization_property: type: object properties: include: type: array description: The organization properties and values to include. All of these properties must match for the condition to pass. items: "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-spec" exclude: type: array description: The organization properties and values to exclude. The condition will not pass if any of these properties match. items: "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-spec" required: - organization_property enterprise-ruleset-conditions: title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property. oneOf: - type: object title: organization_name_and_repository_name description: Conditions to target organizations by name and all repositories allOf: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" - type: object title: organization_name_and_repository_property description: Conditions to target organizations by name and repositories by property allOf: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" - type: object title: organization_property_and_repository_name description: Conditions to target organizations by property and all repositories allOf: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" - type: object title: organization_property_and_repository_property description: Conditions to target organizations by property and repositories by property allOf: - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-property-target" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - "$ref": "#/components/schemas/repository-ruleset-conditions" repository-rule-creation: title: creation description: Only allow users with bypass permission to create matching refs. type: object required: - type properties: type: type: string enum: - creation repository-rule-update: title: update description: Only allow users with bypass permission to update matching refs. type: object required: - type properties: type: type: string enum: - update parameters: type: object properties: update_allows_fetch_and_merge: type: boolean description: Branch can pull changes from its upstream repository required: - update_allows_fetch_and_merge repository-rule-deletion: title: deletion description: Only allow users with bypass permissions to delete matching refs. type: object required: - type properties: type: type: string enum: - deletion repository-rule-required-linear-history: title: required_linear_history description: Prevent merge commits from being pushed to matching refs. type: object required: - type properties: type: type: string enum: - required_linear_history repository-rule-required-deployments: title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. type: object required: - type properties: type: type: string enum: - required_deployments parameters: type: object properties: required_deployment_environments: type: array description: The environments that must be successfully deployed to before branches can be merged. items: type: string required: - required_deployment_environments repository-rule-required-signatures: title: required_signatures description: Commits pushed to matching refs must have verified signatures. type: object required: - type properties: type: type: string enum: - required_signatures repository-rule-params-reviewer: title: Reviewer description: A required reviewing team type: object properties: id: type: integer description: ID of the reviewer which must review changes to matching files. type: type: string description: The type of the reviewer enum: - Team required: - id - type repository-rule-params-required-reviewer-configuration: title: RequiredReviewerConfiguration description: A reviewing team, and file patterns describing which files they must approve changes to. type: object properties: file_patterns: type: array description: Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax. items: type: string minimum_approvals: type: integer description: Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. reviewer: "$ref": "#/components/schemas/repository-rule-params-reviewer" required: - file_patterns - minimum_approvals - reviewer repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. type: object required: - type properties: type: type: string enum: - pull_request parameters: type: object properties: allowed_merge_methods: type: array description: Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. items: type: string enum: - merge - squash - rebase automatic_copilot_code_review_enabled: type: boolean description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull request review approvals. require_code_owner_review: type: boolean description: Require an approving review in pull requests that modify files that have a designated code owner. require_last_push_approval: type: boolean description: Whether the most recent reviewable push must be approved by someone other than the person who pushed it. required_approving_review_count: type: integer description: The number of approving reviews that are required before a pull request can be merged. minimum: 0 maximum: 10 required_review_thread_resolution: type: boolean description: All conversations on code must be resolved before a pull request can be merged. required_reviewers: type: array description: |- > [!NOTE] > `required_reviewers` is in beta and subject to change. A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. items: "$ref": "#/components/schemas/repository-rule-params-required-reviewer-configuration" required: - dismiss_stale_reviews_on_push - require_code_owner_review - require_last_push_approval - required_approving_review_count - required_review_thread_resolution repository-rule-params-status-check-configuration: title: StatusCheckConfiguration description: Required status check type: object properties: context: type: string description: The status check context name that must be present on the commit. integration_id: type: integer description: The optional integration ID that this status check must originate from. required: - context repository-rule-required-status-checks: title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. type: object required: - type properties: type: type: string enum: - required_status_checks parameters: type: object properties: do_not_enforce_on_create: type: boolean description: Allow repositories and branches to be created if a check would otherwise prohibit it. required_status_checks: type: array description: Status checks that are required. items: "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" strict_required_status_checks_policy: type: boolean description: Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. required: - required_status_checks - strict_required_status_checks_policy repository-rule-non-fast-forward: title: non_fast_forward description: Prevent users with push access from force pushing to refs. type: object required: - type properties: type: type: string enum: - non_fast_forward repository-rule-commit-message-pattern: title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule type: object required: - type properties: type: type: string enum: - commit_message_pattern parameters: type: object properties: name: type: string description: How this rule will appear to users. negate: type: boolean description: If true, the rule will fail if the pattern matches. operator: type: string description: The operator to use for matching. enum: - starts_with - ends_with - contains - regex pattern: type: string description: The pattern to match with. required: - operator - pattern repository-rule-commit-author-email-pattern: title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule type: object required: - type properties: type: type: string enum: - commit_author_email_pattern parameters: type: object properties: name: type: string description: How this rule will appear to users. negate: type: boolean description: If true, the rule will fail if the pattern matches. operator: type: string description: The operator to use for matching. enum: - starts_with - ends_with - contains - regex pattern: type: string description: The pattern to match with. required: - operator - pattern repository-rule-committer-email-pattern: title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule type: object required: - type properties: type: type: string enum: - committer_email_pattern parameters: type: object properties: name: type: string description: How this rule will appear to users. negate: type: boolean description: If true, the rule will fail if the pattern matches. operator: type: string description: The operator to use for matching. enum: - starts_with - ends_with - contains - regex pattern: type: string description: The pattern to match with. required: - operator - pattern repository-rule-branch-name-pattern: title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule type: object required: - type properties: type: type: string enum: - branch_name_pattern parameters: type: object properties: name: type: string description: How this rule will appear to users. negate: type: boolean description: If true, the rule will fail if the pattern matches. operator: type: string description: The operator to use for matching. enum: - starts_with - ends_with - contains - regex pattern: type: string description: The pattern to match with. required: - operator - pattern repository-rule-tag-name-pattern: title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule type: object required: - type properties: type: type: string enum: - tag_name_pattern parameters: type: object properties: name: type: string description: How this rule will appear to users. negate: type: boolean description: If true, the rule will fail if the pattern matches. operator: type: string description: The operator to use for matching. enum: - starts_with - ends_with - contains - regex pattern: type: string description: The pattern to match with. required: - operator - pattern repository-rule-file-path-restriction: title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. type: object required: - type properties: type: type: string enum: - file_path_restriction parameters: type: object properties: restricted_file_paths: type: array description: The file paths that are restricted from being pushed to the commit graph. items: type: string required: - restricted_file_paths repository-rule-max-file-path-length: title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. type: object required: - type properties: type: type: string enum: - max_file_path_length parameters: type: object properties: max_file_path_length: type: integer description: The maximum amount of characters allowed in file paths. minimum: 1 maximum: 32767 required: - max_file_path_length repository-rule-file-extension-restriction: title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. type: object required: - type properties: type: type: string enum: - file_extension_restriction parameters: type: object properties: restricted_file_extensions: type: array description: The file extensions that are restricted from being pushed to the commit graph. items: type: string required: - restricted_file_extensions repository-rule-max-file-size: title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. type: object required: - type properties: type: type: string enum: - max_file_size parameters: type: object properties: max_file_size: type: integer description: The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). minimum: 1 maximum: 100 required: - max_file_size repository-rule-params-restricted-commits: title: RestrictedCommits description: Restricted commit type: object properties: oid: type: string description: Full or abbreviated commit hash to reject reason: type: string description: Reason for restriction required: - oid repository-rule-params-workflow-file-reference: title: WorkflowFileReference description: A workflow that must run for this rule to pass type: object properties: path: type: string description: The path to the workflow file ref: type: string description: The ref (branch or tag) of the workflow file to use repository_id: type: integer description: The ID of the repository where the workflow is defined sha: type: string description: The commit SHA of the workflow file to use required: - path - repository_id repository-rule-workflows: title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. type: object required: - type properties: type: type: string enum: - workflows parameters: type: object properties: do_not_enforce_on_create: type: boolean description: Allow repositories and branches to be created if a check would otherwise prohibit it. workflows: type: array description: Workflows that must pass for this rule to pass. items: "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" required: - workflows repository-rule-params-code-scanning-tool: title: CodeScanningTool description: A tool that must provide code scanning results for this rule to pass. type: object properties: alerts_threshold: type: string description: The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." enum: - none - errors - errors_and_warnings - all security_alerts_threshold: type: string description: The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." enum: - none - critical - high_or_higher - medium_or_higher - all tool: type: string description: The name of a code scanning tool required: - alerts_threshold - security_alerts_threshold - tool repository-rule-code-scanning: title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. type: object required: - type properties: type: type: string enum: - code_scanning parameters: type: object properties: code_scanning_tools: type: array description: Tools that must provide code scanning results for this rule to pass. items: "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" required: - code_scanning_tools enterprise-rules: title: Repository Rule type: object description: A repository rule. oneOf: - "$ref": "#/components/schemas/repository-rule-creation" - "$ref": "#/components/schemas/repository-rule-update" - "$ref": "#/components/schemas/repository-rule-deletion" - "$ref": "#/components/schemas/repository-rule-required-linear-history" - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-required-signatures" - "$ref": "#/components/schemas/repository-rule-pull-request" - "$ref": "#/components/schemas/repository-rule-required-status-checks" - "$ref": "#/components/schemas/repository-rule-non-fast-forward" - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-code-scanning" repository-ruleset-conditions-repository-id-target: title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition properties: repository_id: type: object properties: repository_ids: type: array description: The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. items: type: integer required: - repository_id org-ruleset-conditions: title: Organization ruleset conditions type: object description: |- Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name description: Conditions to target repositories by name and refs by name allOf: - "$ref": "#/components/schemas/repository-ruleset-conditions" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - "$ref": "#/components/schemas/repository-ruleset-conditions" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" - type: object title: repository_property_and_ref_name description: Conditions to target repositories by property and refs by name allOf: - "$ref": "#/components/schemas/repository-ruleset-conditions" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" repository-rule-merge-queue: title: merge_queue description: Merges must be performed via a merge queue. type: object required: - type properties: type: type: string enum: - merge_queue parameters: type: object properties: check_response_timeout_minutes: type: integer description: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed minimum: 1 maximum: 360 grouping_strategy: type: string description: When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. enum: - ALLGREEN - HEADGREEN max_entries_to_build: type: integer description: Limit the number of queued pull requests requesting checks and workflow runs at the same time. minimum: 0 maximum: 100 max_entries_to_merge: type: integer description: The maximum number of PRs that will be merged together in a group. minimum: 0 maximum: 100 merge_method: type: string description: Method to use when merging changes from queued pull requests. enum: - MERGE - SQUASH - REBASE min_entries_to_merge: type: integer description: The minimum number of PRs that will be merged together in a group. minimum: 0 maximum: 100 min_entries_to_merge_wait_minutes: type: integer description: The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. minimum: 0 maximum: 360 required: - check_response_timeout_minutes - grouping_strategy - max_entries_to_build - max_entries_to_merge - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes repository-rule-copilot-code-review: title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. type: object required: - type properties: type: type: string enum: - copilot_code_review parameters: type: object properties: review_draft_pull_requests: type: boolean description: Copilot automatically reviews draft pull requests before they are marked as ready for review. review_on_push: type: boolean description: Copilot automatically reviews each new push to the pull request. repository-rule: title: Repository Rule type: object description: A repository rule. oneOf: - "$ref": "#/components/schemas/repository-rule-creation" - "$ref": "#/components/schemas/repository-rule-update" - "$ref": "#/components/schemas/repository-rule-deletion" - "$ref": "#/components/schemas/repository-rule-required-linear-history" - "$ref": "#/components/schemas/repository-rule-merge-queue" - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-required-signatures" - "$ref": "#/components/schemas/repository-rule-pull-request" - "$ref": "#/components/schemas/repository-rule-required-status-checks" - "$ref": "#/components/schemas/repository-rule-non-fast-forward" - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-code-scanning" - "$ref": "#/components/schemas/repository-rule-copilot-code-review" repository-ruleset: title: Repository ruleset type: object description: A set of rules to apply when specified conditions are met. required: - id - name - source - enforcement properties: id: type: integer description: The ID of the ruleset name: type: string description: The name of the ruleset target: type: string description: The target of the ruleset enum: - branch - tag - push - repository source_type: type: string description: The type of the source of the ruleset enum: - Repository - Organization - Enterprise source: type: string description: The name of the source enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: type: array description: The actors that can bypass the rules in this ruleset items: "$ref": "#/components/schemas/repository-ruleset-bypass-actor" current_user_can_bypass: type: string description: |- The bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint. enum: - always - pull_requests_only - never - exempt node_id: type: string _links: type: object properties: self: type: object properties: href: type: string description: The URL of the ruleset html: type: object nullable: true properties: href: type: string description: The html URL of the ruleset conditions: nullable: true anyOf: - "$ref": "#/components/schemas/repository-ruleset-conditions" - "$ref": "#/components/schemas/org-ruleset-conditions" rules: type: array items: "$ref": "#/components/schemas/repository-rule" created_at: type: string format: date-time updated_at: type: string format: date-time ruleset-version: title: Ruleset version type: object description: The historical version of a ruleset required: - version_id - actor - updated_at properties: version_id: type: integer description: The ID of the previous version of the ruleset actor: type: object description: The actor who updated the ruleset properties: id: type: integer type: type: string updated_at: type: string format: date-time ruleset-version-with-state: allOf: - "$ref": "#/components/schemas/ruleset-version" - type: object required: - state properties: state: type: object description: The state of the ruleset version nullable-alert-updated-at: type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true secret-scanning-alert-state: description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved secret-scanning-alert-resolution: type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." nullable: true enum: - false_positive - wont_fix - revoked - used_in_tests secret-scanning-location-commit: description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. type: object properties: path: type: string description: The file path in the repository example: "/example/secrets.txt" start_line: type: number description: Line number at which the secret starts in the file end_line: type: number description: Line number at which the secret ends in the file start_column: type: number description: The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII end_column: type: number description: The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII blob_sha: type: string description: SHA-1 hash ID of the associated blob example: af5626b4a114abcb82d63db7c8082c3c4756e51b blob_url: type: string description: The API URL to get the associated blob resource commit_sha: type: string description: SHA-1 hash ID of the associated commit example: af5626b4a114abcb82d63db7c8082c3c4756e51b commit_url: type: string description: The API URL to get the associated commit resource required: - path - start_line - end_line - start_column - end_column - blob_sha - blob_url - commit_sha - commit_url secret-scanning-location-wiki-commit: description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. type: object properties: path: type: string description: The file path of the wiki page example: "/example/Home.md" start_line: type: number description: Line number at which the secret starts in the file end_line: type: number description: Line number at which the secret ends in the file start_column: type: number description: The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. end_column: type: number description: The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. blob_sha: type: string description: SHA-1 hash ID of the associated blob example: af5626b4a114abcb82d63db7c8082c3c4756e51b page_url: type: string description: The GitHub URL to get the associated wiki page example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 commit_sha: type: string description: SHA-1 hash ID of the associated commit example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 commit_url: type: string description: The GitHub URL to get the associated wiki commit example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 required: - path - start_line - end_line - start_column - end_column - blob_sha - page_url - commit_sha - commit_url secret-scanning-location-issue-title: description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. type: object properties: issue_title_url: type: string format: uri description: The API URL to get the issue where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url secret-scanning-location-issue-body: description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. type: object properties: issue_body_url: type: string format: uri description: The API URL to get the issue where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url secret-scanning-location-issue-comment: description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. type: object properties: issue_comment_url: type: string format: uri description: The API URL to get the issue comment where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. type: object properties: discussion_title_url: type: string format: uri description: The URL to the discussion where the secret was detected. example: https://github.com/community/community/discussions/39082 required: - discussion_title_url secret-scanning-location-discussion-body: description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. type: object properties: discussion_body_url: type: string format: uri description: The URL to the discussion where the secret was detected. example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url secret-scanning-location-discussion-comment: description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. type: object properties: discussion_comment_url: type: string format: uri description: The API URL to get the discussion comment where the secret was detected. example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url secret-scanning-location-pull-request-title: description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. type: object properties: pull_request_title_url: type: string format: uri description: The API URL to get the pull request where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. type: object properties: pull_request_body_url: type: string format: uri description: The API URL to get the pull request where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. type: object properties: pull_request_comment_url: type: string format: uri description: The API URL to get the pull request comment where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. type: object properties: pull_request_review_url: type: string format: uri description: The API URL to get the pull request review where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. type: object properties: pull_request_review_comment_url: type: string format: uri description: The API URL to get the pull request review comment where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 required: - pull_request_review_comment_url nullable-secret-scanning-first-detected-location: description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - "$ref": "#/components/schemas/secret-scanning-location-commit" - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" nullable: true organization-secret-scanning-alert: type: object properties: number: "$ref": "#/components/schemas/alert-number" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/nullable-alert-updated-at" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. state: "$ref": "#/components/schemas/secret-scanning-alert-state" resolution: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolved_at: type: string format: date-time description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true resolved_by: "$ref": "#/components/schemas/nullable-simple-user" secret_type: type: string description: The type of secret that secret scanning detected. secret_type_display_name: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." secret: type: string description: The secret that was detected. repository: "$ref": "#/components/schemas/simple-repository" push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected secret. nullable: true push_protection_bypassed_by: "$ref": "#/components/schemas/nullable-simple-user" push_protection_bypassed_at: type: string format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" push_protection_bypass_request_reviewer_comment: type: string description: An optional comment when reviewing a push protection bypass. nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. nullable: true push_protection_bypass_request_html_url: type: string format: uri description: The URL to a push protection bypass request. nullable: true resolution_comment: type: string description: The comment that was optionally added when this alert was closed nullable: true validity: type: string description: The token status as of the latest validity check. enum: - active - inactive - unknown publicly_leaked: type: boolean description: Whether the secret was publicly leaked. nullable: true multi_repo: type: boolean description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. nullable: true is_base64_encoded: type: boolean description: A boolean value representing whether or not alert is base64 encoded nullable: true first_location_detected: "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" has_more_locations: type: boolean description: A boolean value representing whether or not the token in the alert was detected in more than one location. assigned_to: "$ref": "#/components/schemas/nullable-simple-user" secret-scanning-row-version: type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. nullable: true secret-scanning-pattern-override: type: object properties: token_type: type: string description: The ID of the pattern. custom_pattern_version: type: string description: The version of this pattern if it's a custom pattern. nullable: true slug: type: string description: The slug of the pattern. display_name: type: string description: The user-friendly name for the pattern. alert_total: type: integer description: The total number of alerts generated by this pattern. alert_total_percentage: type: integer description: The percentage of all alerts that this pattern represents, rounded to the nearest integer. false_positives: type: integer description: The number of false positive alerts generated by this pattern. false_positive_rate: type: integer description: The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. bypass_rate: type: integer description: The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. default_setting: type: string description: The default push protection setting for this pattern. enum: - disabled - enabled enterprise_setting: type: string description: The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. enum: - not-set - disabled - enabled nullable: true setting: type: string description: The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. enum: - not-set - disabled - enabled secret-scanning-pattern-configuration: title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. type: object properties: pattern_config_version: "$ref": "#/components/schemas/secret-scanning-row-version" provider_pattern_overrides: type: array description: Overrides for partner patterns. items: "$ref": "#/components/schemas/secret-scanning-pattern-override" custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. items: "$ref": "#/components/schemas/secret-scanning-pattern-override" actions-billing-usage: type: object properties: total_minutes_used: type: integer description: The sum of the free and paid GitHub Actions minutes used. total_paid_minutes_used: type: integer description: The total paid GitHub Actions minutes used. included_minutes: type: integer description: The amount of free GitHub Actions minutes available. minutes_used_breakdown: type: object properties: UBUNTU: type: integer description: Total minutes used on Ubuntu runner machines. MACOS: type: integer description: Total minutes used on macOS runner machines. WINDOWS: type: integer description: Total minutes used on Windows runner machines. ubuntu_4_core: type: integer description: Total minutes used on Ubuntu 4 core runner machines. ubuntu_8_core: type: integer description: Total minutes used on Ubuntu 8 core runner machines. ubuntu_16_core: type: integer description: Total minutes used on Ubuntu 16 core runner machines. ubuntu_32_core: type: integer description: Total minutes used on Ubuntu 32 core runner machines. ubuntu_64_core: type: integer description: Total minutes used on Ubuntu 64 core runner machines. windows_4_core: type: integer description: Total minutes used on Windows 4 core runner machines. windows_8_core: type: integer description: Total minutes used on Windows 8 core runner machines. windows_16_core: type: integer description: Total minutes used on Windows 16 core runner machines. windows_32_core: type: integer description: Total minutes used on Windows 32 core runner machines. windows_64_core: type: integer description: Total minutes used on Windows 64 core runner machines. macos_12_core: type: integer description: Total minutes used on macOS 12 core runner machines. total: type: integer description: Total minutes used on all runner machines. required: - total_minutes_used - total_paid_minutes_used - included_minutes - minutes_used_breakdown advanced-security-active-committers-user: type: object properties: user_login: type: string last_pushed_date: type: string example: '2021-11-03' last_pushed_email: type: string example: monalisa@github.com required: - user_login - last_pushed_date - last_pushed_email advanced-security-active-committers-repository: type: object properties: name: type: string example: octocat/Hello-World advanced_security_committers: type: integer example: 25 advanced_security_committers_breakdown: type: array items: "$ref": "#/components/schemas/advanced-security-active-committers-user" required: - name - advanced_security_committers - advanced_security_committers_breakdown advanced-security-active-committers: type: object properties: total_advanced_security_committers: type: integer example: 25 total_count: type: integer example: 2 maximum_advanced_security_committers: type: integer example: 4 description: The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security purchased_advanced_security_committers: type: integer example: 4 description: The total number of GitHub Advanced Security licences purchased repositories: type: array items: "$ref": "#/components/schemas/advanced-security-active-committers-repository" required: - repositories budget: type: object properties: id: type: string description: The unique identifier for the budget example: 2066deda-923f-43f9-88d2-62395a28c0cdd budget_type: type: string description: The type of pricing for the budget example: SkuPricing enum: - SkuPricing - ProductPricing budget_amount: type: integer description: The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. prevent_further_usage: type: boolean description: The type of limit enforcement for the budget example: true budget_scope: type: string description: The scope of the budget (enterprise, organization, repository, cost center) example: enterprise budget_entity_name: type: string description: The name of the entity for the budget (enterprise does not require a name). example: octocat/hello-world budget_product_sku: type: string description: A single product or sku to apply the budget to. budget_alerting: type: object properties: will_alert: type: boolean description: Whether alerts are enabled for this budget example: true alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts example: - mona - lisa required: - will_alert - alert_recipients required: - id - budget_type - budget_product_sku - budget_scope - budget_amount - prevent_further_usage - budget_alerting get_all_budgets: type: object properties: budgets: type: array items: "$ref": "#/components/schemas/budget" description: Array of budget objects for the enterprise required: - budgets create-budget: type: object properties: message: type: string description: A message indicating the result of the create operation budget: type: object properties: id: type: string description: ID of the budget. budget_scope: type: string description: The type of scope for the budget example: enterprise enum: - enterprise - organization - repository - cost_center budget_entity_name: type: string description: The name of the entity to apply the budget to example: example-repository-name budget_amount: type: number format: float description: The budget amount in dollars example: 100.0 minimum: 0.0 prevent_further_usage: type: boolean description: Whether to prevent additional spending once the budget is exceeded example: true budget_product_sku: type: string description: A single product or sku to apply the budget to. example: actions_linux budget_type: type: string description: The type of pricing for the budget example: ProductPricing enum: - ProductPricing - SkuPricing budget_alerting: type: object properties: will_alert: type: boolean description: Whether alerts are enabled for this budget example: true alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts example: - mona - lisa required: - message - budget get-budget: type: object properties: id: type: string description: ID of the budget. budget_scope: type: string description: The type of scope for the budget example: enterprise enum: - enterprise - organization - repository - cost_center budget_entity_name: type: string description: The name of the entity to apply the budget to example: octocat/hello-world budget_amount: type: integer description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. prevent_further_usage: type: boolean description: Whether to prevent additional spending once the budget is exceeded example: true budget_product_sku: type: string description: A single product or sku to apply the budget to. example: actions_linux budget_type: type: string description: The type of pricing for the budget example: ProductPricing enum: - ProductPricing - SkuPricing budget_alerting: type: object properties: will_alert: type: boolean description: Whether alerts are enabled for this budget example: true alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts example: - mona - lisa required: - id - budget_amount - prevent_further_usage - budget_product_sku - budget_type - budget_alerting - budget_scope - budget_entity_name update-budget: type: object properties: message: type: string description: A message indicating the result of the update operation budget: type: object properties: id: type: string description: ID of the budget. budget_scope: type: string description: The type of scope for the budget example: enterprise enum: - enterprise - organization - repository - cost_center budget_entity_name: type: string description: The name of the entity to apply the budget to example: example-repository-name budget_amount: type: number format: float description: The budget amount in dollars example: 100.0 minimum: 0.0 prevent_further_usage: type: boolean description: Whether to prevent additional spending once the budget is exceeded example: true budget_product_sku: type: string description: A single product or sku to apply the budget to. example: actions_linux budget_type: type: string description: The type of pricing for the budget example: ProductPricing enum: - ProductPricing - SkuPricing budget_alerting: type: object properties: will_alert: type: boolean description: Whether alerts are enabled for this budget example: true alert_recipients: type: array items: type: string description: Array of user login names who will receive alerts example: - mona - lisa required: - budget - message delete-budget: type: object properties: message: type: string description: A message indicating the result of the deletion operation id: type: string description: The ID of the deleted budget required: - message - id get-all-cost-centers: type: object properties: costCenters: type: array items: type: object properties: id: type: string description: ID of the cost center. name: type: string description: Name of the cost center. state: type: string description: State of the cost center. enum: - active - deleted azure_subscription: type: string nullable: true description: Azure subscription ID associated with the cost center. Only present for cost centers linked to Azure subscriptions. resources: type: array items: type: object properties: type: type: string description: Type of the resource. name: type: string description: Name of the resource. required: - type - name required: - id - name - resources get-cost-center: type: object properties: id: type: string description: ID of the cost center. name: type: string description: Name of the cost center. azure_subscription: type: string nullable: true description: Azure subscription ID associated with the cost center. Only present for cost centers linked to Azure subscriptions. state: type: string description: State of the cost center. enum: - active - deleted resources: type: array items: type: object properties: type: type: string description: Type of the resource. name: type: string description: Name of the resource. required: - type - name required: - id - name - resources delete-cost-center: type: object properties: message: type: string description: A message indicating the result of the deletion operation id: type: string description: The unique identifier of the deleted cost center name: type: string description: The name of the deleted cost center costCenterState: type: string enum: - CostCenterArchived description: The state of the cost center after deletion required: - message - id - name - costCenterState packages-billing-usage: type: object properties: total_gigabytes_bandwidth_used: type: integer description: Sum of the free and paid storage space (GB) for GitHuub Packages. total_paid_gigabytes_bandwidth_used: type: integer description: Total paid storage space (GB) for GitHuub Packages. included_gigabytes_bandwidth: type: integer description: Free storage space (GB) for GitHub Packages. required: - total_gigabytes_bandwidth_used - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth billing-premium-request-usage-report-ghe: type: object properties: timePeriod: type: object properties: year: type: integer description: The year for the usage report. month: type: integer description: The month for the usage report. day: type: integer description: The day for the usage report. required: - year enterprise: type: string description: The unique identifier of the enterprise. user: type: string description: The name of the user for the usage report. organization: type: string description: The name of the organization for the usage report. product: type: string description: The product for the usage report. model: type: string description: The model for the usage report. costCenter: type: object properties: id: type: string description: The unique identifier of the cost center. name: type: string description: The name of the cost center. required: - id - name usageItems: type: array items: type: object properties: product: type: string description: Product name. sku: type: string description: SKU name. model: type: string description: Model name. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossQuantity: type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: type: number description: Net quantity of the usage line item. netAmount: type: number description: Net amount of the usage line item. required: - product - sku - model - unitType - pricePerUnit - grossQuantity - grossAmount - discountQuantity - discountAmount - netQuantity - netAmount required: - timePeriod - enterprise - usageItems combined-billing-usage: type: object properties: days_left_in_billing_cycle: type: integer description: Numbers of days left in billing cycle. estimated_paid_storage_for_month: type: integer description: Estimated storage space (GB) used in billing cycle. estimated_storage_for_month: type: integer description: Estimated sum of free and paid storage space (GB) used in billing cycle. required: - days_left_in_billing_cycle - estimated_paid_storage_for_month - estimated_storage_for_month billing-usage-report: type: object properties: usageItems: type: array items: type: object properties: date: type: string description: Date of the usage line item. product: type: string description: Product name. sku: type: string description: SKU name. quantity: type: integer description: Quantity of the usage line item. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netAmount: type: number description: Net amount of the usage line item. organizationName: type: string description: Name of the organization. repositoryName: type: string description: Name of the repository. required: - date - product - sku - quantity - unitType - pricePerUnit - grossAmount - discountAmount - netAmount - organizationName billing-usage-summary-report-ghe: type: object properties: timePeriod: type: object properties: year: type: integer description: The year for the usage report. month: type: integer description: The month for the usage report. day: type: integer description: The day for the usage report. required: - year enterprise: type: string description: The unique identifier of the enterprise. organization: type: string description: The name of the organization for the usage report. repository: type: string description: The name of the repository for the usage report. product: type: string description: The product for the usage report. sku: type: string description: The SKU for the usage report. costCenter: type: object properties: id: type: string description: The unique identifier of the cost center. name: type: string description: The name of the cost center. required: - id - name usageItems: type: array items: type: object properties: product: type: string description: Product name. sku: type: string description: SKU name. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossQuantity: type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: type: number description: Net quantity of the usage line item. netAmount: type: number description: Net amount of the usage line item. required: - product - sku - unitType - pricePerUnit - grossQuantity - grossAmount - discountQuantity - discountAmount - netQuantity - netAmount required: - timePeriod - enterprise - usageItems actor: title: Actor description: Actor type: object properties: id: type: integer login: type: string display_login: type: string gravatar_id: type: string nullable: true url: type: string format: uri avatar_url: type: string format: uri required: - id - login - gravatar_id - url - avatar_url nullable-milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: type: string format: uri example: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: type: integer example: 1002604 node_id: type: string example: MDk6TWlsZXN0b25lMTAwMjYwNA== number: description: The number of the milestone. type: integer example: 42 state: description: The state of the milestone. example: open type: string enum: - open - closed default: open title: description: The title of the milestone. example: v1.0 type: string description: type: string example: Tracking milestone for version 1.0 nullable: true creator: "$ref": "#/components/schemas/nullable-simple-user" open_issues: type: integer example: 4 closed_issues: type: integer example: 8 created_at: type: string format: date-time example: '2011-04-10T20:09:31Z' updated_at: type: string format: date-time example: '2014-03-03T18:58:10Z' closed_at: type: string format: date-time example: '2013-02-12T13:22:01Z' nullable: true due_on: type: string format: date-time example: '2012-10-09T23:39:01Z' nullable: true required: - closed_issues - creator - description - due_on - closed_at - id - node_id - labels_url - html_url - number - open_issues - state - title - url - created_at - updated_at nullable: true issue-type: title: Issue Type description: The type of issue. type: object nullable: true properties: id: type: integer description: The unique identifier of the issue type. node_id: type: string description: The node identifier of the issue type. name: type: string description: The name of the issue type. description: type: string description: The description of the issue type. nullable: true color: type: string description: The color of the issue type. enum: - gray - blue - green - yellow - orange - red - pink - purple nullable: true created_at: type: string description: The time the issue type created. format: date-time updated_at: type: string description: The time the issue type last updated. format: date-time is_enabled: type: boolean description: The enabled state of the issue type. required: - id - node_id - name - description nullable-integration: title: GitHub app description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: id: description: Unique identifier of the GitHub app example: 37 type: integer slug: description: The slug name of the GitHub app example: probot-owners type: string node_id: type: string example: MDExOkludGVncmF0aW9uMQ== client_id: type: string example: '"Iv1.25b5d1e65ffc4022"' owner: oneOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/enterprise" name: description: The name of the GitHub app example: Probot Owners type: string description: type: string example: The description of the app. nullable: true external_url: type: string format: uri example: https://example.com html_url: type: string format: uri example: https://github.com/apps/super-ci created_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' updated_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' permissions: description: The set of permissions for the GitHub app type: object properties: issues: type: string checks: type: string metadata: type: string contents: type: string deployments: type: string additionalProperties: type: string example: issues: read deployments: write events: description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. example: - label - deployment type: array items: type: string installations_count: description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. example: 5 type: integer required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at - permissions - events author-association: title: author_association type: string example: OWNER description: How the author is associated with the repository. enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER reaction-rollup: title: Reaction Rollup type: object properties: url: type: string format: uri total_count: type: integer "+1": type: integer "-1": type: integer laugh: type: integer confused: type: integer heart: type: integer hooray: type: integer eyes: type: integer rocket: type: integer required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket sub-issues-summary: title: Sub-issues Summary type: object properties: total: type: integer completed: type: integer percent_completed: type: integer required: - total - completed - percent_completed issue-dependencies-summary: title: Issue Dependencies Summary type: object properties: blocked_by: type: integer blocking: type: integer total_blocked_by: type: integer total_blocking: type: integer required: - blocked_by - blocking - total_blocked_by - total_blocking issue-field-value: title: Issue Field Value description: A value assigned to an issue field type: object properties: issue_field_id: description: Unique identifier for the issue field. type: integer format: int64 example: 1 node_id: type: string example: IFT_GDKND data_type: description: The data type of the issue field type: string enum: - text - single_select - number - date example: text value: description: The value of the issue field anyOf: - type: string example: Sample text - type: number example: 42.5 - type: integer example: 1 nullable: true single_select_option: description: Details about the selected option (only present for single_select fields) type: object properties: id: description: Unique identifier for the option. type: integer format: int64 example: 1 name: description: The name of the option type: string example: High color: description: The color of the option type: string example: red required: - id - name - color nullable: true required: - issue_field_id - node_id - data_type - value issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object properties: id: type: integer format: int64 node_id: type: string url: description: URL for the issue example: https://api.github.com/repositories/42/issues/1 type: string format: uri repository_url: type: string format: uri labels_url: type: string comments_url: type: string format: uri events_url: type: string format: uri html_url: type: string format: uri number: description: Number uniquely identifying the issue within its repository example: 42 type: integer state: description: State of the issue; either 'open' or 'closed' example: open type: string state_reason: description: The reason for the current state example: not_planned type: string nullable: true enum: - completed - reopened - not_planned - duplicate title: description: Title of the issue example: Widget creation fails in Safari on OS X 10.8 type: string body: description: Contents of the issue example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? type: string nullable: true user: "$ref": "#/components/schemas/nullable-simple-user" labels: description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository example: - bug - registration type: array items: oneOf: - type: string - type: object properties: id: type: integer format: int64 node_id: type: string url: type: string format: uri name: type: string description: type: string nullable: true color: type: string nullable: true default: type: boolean assignee: "$ref": "#/components/schemas/nullable-simple-user" assignees: type: array items: "$ref": "#/components/schemas/simple-user" nullable: true milestone: "$ref": "#/components/schemas/nullable-milestone" locked: type: boolean active_lock_reason: type: string nullable: true comments: type: integer pull_request: type: object properties: merged_at: type: string format: date-time nullable: true diff_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true patch_url: type: string format: uri nullable: true url: type: string format: uri nullable: true required: - diff_url - html_url - patch_url - url closed_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time draft: type: boolean closed_by: "$ref": "#/components/schemas/nullable-simple-user" body_html: type: string body_text: type: string timeline_url: type: string format: uri type: "$ref": "#/components/schemas/issue-type" repository: "$ref": "#/components/schemas/repository" performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" author_association: "$ref": "#/components/schemas/author-association" reactions: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" parent_issue_url: description: URL to get the parent issue of this issue, if it is a sub-issue type: string format: uri nullable: true issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" issue_field_values: type: array items: "$ref": "#/components/schemas/issue-field-value" required: - assignee - closed_at - comments - comments_url - events_url - html_url - id - node_id - labels - labels_url - milestone - number - repository_url - state - locked - title - url - user - created_at - updated_at issue-comment: title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object properties: id: description: Unique identifier of the issue comment example: 42 type: integer format: int64 node_id: type: string url: description: URL for the issue comment example: https://api.github.com/repositories/42/issues/comments/1 type: string format: uri body: description: Contents of the issue comment example: What version of Safari were you using when you observed this bug? type: string body_text: type: string body_html: type: string html_url: type: string format: uri user: "$ref": "#/components/schemas/nullable-simple-user" created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' updated_at: type: string format: date-time example: '2011-04-14T16:00:49Z' issue_url: type: string format: uri author_association: "$ref": "#/components/schemas/author-association" performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" reactions: "$ref": "#/components/schemas/reaction-rollup" required: - id - node_id - html_url - issue_url - author_association - user - url - created_at - updated_at event: title: Event description: Event type: object properties: id: type: string type: type: string nullable: true actor: "$ref": "#/components/schemas/actor" repo: type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - name - url org: "$ref": "#/components/schemas/actor" payload: type: object properties: action: type: string issue: "$ref": "#/components/schemas/issue" comment: "$ref": "#/components/schemas/issue-comment" pages: type: array items: type: object properties: page_name: type: string title: type: string summary: type: string nullable: true action: type: string sha: type: string html_url: type: string public: type: boolean created_at: type: string format: date-time nullable: true required: - id - type - actor - repo - payload - public - created_at link-with-type: title: Link With Type description: Hypermedia Link with Type type: object properties: href: type: string type: type: string required: - href - type feed: title: Feed description: Feed type: object properties: timeline_url: type: string example: https://github.com/timeline user_url: type: string example: https://github.com/{user} current_user_public_url: type: string example: https://github.com/octocat current_user_url: type: string example: https://github.com/octocat.private?token=abc123 current_user_actor_url: type: string example: https://github.com/octocat.private.actor?token=abc123 current_user_organization_url: type: string example: https://github.com/octocat-org current_user_organization_urls: type: array example: - https://github.com/organizations/github/octocat.private.atom?token=abc123 items: type: string format: uri security_advisories_url: type: string example: https://github.com/security-advisories repository_discussions_url: type: string example: https://github.com/{user}/{repo}/discussions description: A feed of discussions for a given repository. repository_discussions_category_url: type: string example: https://github.com/{user}/{repo}/discussions/categories/{category} description: A feed of discussions for a given repository and category. _links: type: object properties: timeline: "$ref": "#/components/schemas/link-with-type" user: "$ref": "#/components/schemas/link-with-type" security_advisories: "$ref": "#/components/schemas/link-with-type" current_user: "$ref": "#/components/schemas/link-with-type" current_user_public: "$ref": "#/components/schemas/link-with-type" current_user_actor: "$ref": "#/components/schemas/link-with-type" current_user_organization: "$ref": "#/components/schemas/link-with-type" current_user_organizations: type: array items: "$ref": "#/components/schemas/link-with-type" repository_discussions: "$ref": "#/components/schemas/link-with-type" repository_discussions_category: "$ref": "#/components/schemas/link-with-type" required: - timeline - user required: - _links - timeline_url - user_url base-gist: title: Base Gist description: Base Gist type: object properties: url: type: string format: uri forks_url: type: string format: uri commits_url: type: string format: uri id: type: string node_id: type: string git_pull_url: type: string format: uri git_push_url: type: string format: uri html_url: type: string format: uri files: type: object additionalProperties: type: object properties: filename: type: string type: type: string language: type: string raw_url: type: string size: type: integer encoding: type: string description: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. default: utf-8 public: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time description: type: string nullable: true comments: type: integer comments_enabled: type: boolean user: "$ref": "#/components/schemas/nullable-simple-user" comments_url: type: string format: uri owner: "$ref": "#/components/schemas/simple-user" truncated: type: boolean forks: type: array items: {} history: type: array items: {} required: - id - node_id - url - forks_url - commits_url - git_pull_url - git_push_url - html_url - comments_url - public - description - comments - user - files - created_at - updated_at public-user: title: Public User description: Public User type: object properties: login: type: string id: type: integer format: int64 user_view_type: type: string node_id: type: string avatar_url: type: string format: uri gravatar_id: type: string nullable: true url: type: string format: uri html_url: type: string format: uri followers_url: type: string format: uri following_url: type: string gists_url: type: string starred_url: type: string subscriptions_url: type: string format: uri organizations_url: type: string format: uri repos_url: type: string format: uri events_url: type: string received_events_url: type: string format: uri type: type: string site_admin: type: boolean name: type: string nullable: true company: type: string nullable: true blog: type: string nullable: true location: type: string nullable: true email: type: string format: email nullable: true notification_email: type: string format: email nullable: true hireable: type: boolean nullable: true bio: type: string nullable: true twitter_username: type: string nullable: true public_repos: type: integer public_gists: type: integer followers: type: integer following: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time plan: type: object properties: collaborators: type: integer name: type: string space: type: integer private_repos: type: integer required: - collaborators - name - space - private_repos private_gists: type: integer example: 1 total_private_repos: type: integer example: 2 owned_private_repos: type: integer example: 2 disk_usage: type: integer example: 1 collaborators: type: integer example: 3 required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url - bio - blog - company - email - followers - following - hireable - location - name - public_gists - public_repos - created_at - updated_at additionalProperties: false gist-history: title: Gist History description: Gist History type: object properties: user: "$ref": "#/components/schemas/nullable-simple-user" version: type: string committed_at: type: string format: date-time change_status: type: object properties: total: type: integer additions: type: integer deletions: type: integer url: type: string format: uri gist-simple: title: Gist Simple description: Gist Simple type: object properties: forks: deprecated: true nullable: true type: array items: type: object properties: id: type: string url: type: string format: uri user: "$ref": "#/components/schemas/public-user" created_at: type: string format: date-time updated_at: type: string format: date-time history: deprecated: true nullable: true type: array items: "$ref": "#/components/schemas/gist-history" fork_of: nullable: true title: Gist description: Gist type: object properties: url: type: string format: uri forks_url: type: string format: uri commits_url: type: string format: uri id: type: string node_id: type: string git_pull_url: type: string format: uri git_push_url: type: string format: uri html_url: type: string format: uri files: type: object additionalProperties: type: object properties: filename: type: string type: type: string language: type: string raw_url: type: string size: type: integer public: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time description: type: string nullable: true comments: type: integer comments_enabled: type: boolean user: "$ref": "#/components/schemas/nullable-simple-user" comments_url: type: string format: uri owner: "$ref": "#/components/schemas/nullable-simple-user" truncated: type: boolean forks: type: array items: {} history: type: array items: {} required: - id - node_id - url - forks_url - commits_url - git_pull_url - git_push_url - html_url - comments_url - public - description - comments - user - files - created_at - updated_at url: type: string forks_url: type: string commits_url: type: string id: type: string node_id: type: string git_pull_url: type: string git_push_url: type: string html_url: type: string files: type: object additionalProperties: nullable: true type: object properties: filename: type: string type: type: string language: type: string raw_url: type: string size: type: integer truncated: type: boolean content: type: string encoding: type: string description: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. default: utf-8 public: type: boolean created_at: type: string updated_at: type: string description: type: string nullable: true comments: type: integer comments_enabled: type: boolean user: type: string nullable: true comments_url: type: string owner: "$ref": "#/components/schemas/simple-user" truncated: type: boolean gist-comment: title: Gist Comment description: A comment made to a gist. type: object properties: id: type: integer example: 1 node_id: type: string example: MDExOkdpc3RDb21tZW50MQ== url: type: string format: uri example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 body: description: The comment text. type: string maxLength: 65535 example: Body of the attachment user: "$ref": "#/components/schemas/nullable-simple-user" created_at: type: string format: date-time example: '2011-04-18T23:23:56Z' updated_at: type: string format: date-time example: '2011-04-18T23:23:56Z' author_association: "$ref": "#/components/schemas/author-association" required: - url - id - node_id - user - body - author_association - created_at - updated_at gist-commit: title: Gist Commit description: Gist Commit type: object properties: url: type: string format: uri example: https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f version: type: string example: 57a7f021a713b1c5a6a199b54cc514735d2d462f user: "$ref": "#/components/schemas/nullable-simple-user" change_status: type: object properties: total: type: integer additions: type: integer deletions: type: integer committed_at: type: string format: date-time example: '2010-04-14T02:15:15Z' required: - url - user - version - committed_at - change_status gitignore-template: title: Gitignore Template description: Gitignore Template type: object properties: name: type: string example: C source: type: string example: | # Object files *.o # Libraries *.lib *.a # Shared objects (inc. Windows DLLs) *.dll *.so *.so.* *.dylib # Executables *.exe *.out *.app required: - name - source license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string nullable: true format: uri example: https://api.github.com/licenses/mit spdx_id: type: string nullable: true example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri required: - key - name - url - spdx_id - node_id license: title: License description: License type: object properties: key: type: string example: mit name: type: string example: MIT License spdx_id: type: string example: MIT nullable: true url: type: string format: uri example: https://api.github.com/licenses/mit nullable: true node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri example: http://choosealicense.com/licenses/mit/ description: type: string example: A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. implementation: type: string example: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. permissions: type: array example: - commercial-use - modifications - distribution - sublicense - private-use items: type: string conditions: type: array example: - include-copyright items: type: string limitations: type: array example: - no-liability items: type: string body: type: string example: |2 The MIT License (MIT) Copyright (c) [year] [fullname] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. featured: type: boolean example: true required: - key - name - url - spdx_id - node_id - html_url - description - implementation - permissions - conditions - limitations - body - featured marketplace-listing-plan: title: Marketplace Listing Plan description: Marketplace Listing Plan type: object properties: url: type: string format: uri example: https://api.github.com/marketplace_listing/plans/1313 accounts_url: type: string format: uri example: https://api.github.com/marketplace_listing/plans/1313/accounts id: type: integer example: 1313 number: type: integer example: 3 name: type: string example: Pro description: type: string example: A professional-grade CI solution monthly_price_in_cents: type: integer example: 1099 yearly_price_in_cents: type: integer example: 11870 price_model: type: string enum: - FREE - FLAT_RATE - PER_UNIT example: FLAT_RATE has_free_trial: type: boolean example: true unit_name: type: string nullable: true state: type: string example: published bullets: type: array items: type: string example: - Up to 25 private repositories - 11 concurrent builds required: - url - accounts_url - id - number - name - description - has_free_trial - price_model - unit_name - monthly_price_in_cents - state - yearly_price_in_cents - bullets marketplace-purchase: title: Marketplace Purchase description: Marketplace Purchase type: object properties: url: type: string type: type: string id: type: integer login: type: string organization_billing_email: type: string email: type: string nullable: true marketplace_pending_change: type: object properties: is_installed: type: boolean effective_date: type: string unit_count: type: integer nullable: true id: type: integer plan: "$ref": "#/components/schemas/marketplace-listing-plan" nullable: true marketplace_purchase: type: object properties: billing_cycle: type: string next_billing_date: type: string nullable: true is_installed: type: boolean unit_count: type: integer nullable: true on_free_trial: type: boolean free_trial_ends_on: type: string nullable: true updated_at: type: string plan: "$ref": "#/components/schemas/marketplace-listing-plan" required: - url - id - type - login - marketplace_purchase api-overview: title: Api Overview description: Api Overview type: object properties: verifiable_password_authentication: type: boolean example: true ssh_key_fingerprints: type: object properties: SHA256_RSA: type: string SHA256_DSA: type: string SHA256_ECDSA: type: string SHA256_ED25519: type: string ssh_keys: type: array items: type: string example: - ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ hooks: type: array items: type: string example: - 192.0.2.1 github_enterprise_importer: type: array items: type: string example: - 192.0.2.1 web: type: array items: type: string example: - 192.0.2.1 api: type: array items: type: string example: - 192.0.2.1 git: type: array items: type: string example: - 192.0.2.1 packages: type: array items: type: string example: - 192.0.2.1 pages: type: array items: type: string example: - 192.0.2.1 importer: type: array items: type: string example: - 192.0.2.1 actions: type: array items: type: string example: - 192.0.2.1 actions_macos: type: array items: type: string example: - 192.0.2.1 codespaces: type: array items: type: string example: - 192.0.2.1 dependabot: type: array items: type: string example: - 192.0.2.1 copilot: type: array items: type: string example: - 192.0.2.1 domains: type: object properties: website: type: array items: type: string example: - example.com codespaces: type: array items: type: string example: - example.com copilot: type: array items: type: string example: - example.com packages: type: array items: type: string example: - example.com actions: type: array items: type: string example: - example.com actions_inbound: type: object properties: full_domains: type: array items: type: string example: - example.com wildcard_domains: type: array items: type: string example: - example.com artifact_attestations: type: object properties: trust_domain: type: string example: - example services: type: array items: type: string example: - example.com required: - verifiable_password_authentication security-and-analysis: nullable: true type: object properties: advanced_security: description: | Enable or disable GitHub Advanced Security for the repository. For standalone Code Scanning or Secret Protection products, this parameter cannot be used. type: object properties: status: type: string enum: - enabled - disabled code_security: type: object properties: status: type: string enum: - enabled - disabled dependabot_security_updates: description: Enable or disable Dependabot security updates for the repository. type: object properties: status: description: The enablement status of Dependabot security updates for the repository. type: string enum: - enabled - disabled secret_scanning: type: object properties: status: type: string enum: - enabled - disabled secret_scanning_push_protection: type: object properties: status: type: string enum: - enabled - disabled secret_scanning_non_provider_patterns: type: object properties: status: type: string enum: - enabled - disabled secret_scanning_ai_detection: type: object properties: status: type: string enum: - enabled - disabled secret_scanning_validity_checks: type: object properties: status: type: string enum: - enabled - disabled minimal-repository: title: Minimal Repository description: Minimal Repository type: object properties: id: type: integer format: int64 example: 1296269 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: type: string example: Hello-World full_name: type: string example: octocat/Hello-World owner: "$ref": "#/components/schemas/simple-user" private: type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string mirror_url: type: string nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string homepage: type: string nullable: true language: type: string nullable: true forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer default_branch: type: string open_issues_count: type: integer is_template: type: boolean topics: type: array items: type: string has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_downloads: type: boolean has_discussions: type: boolean archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean role_name: type: string example: admin temp_clone_token: type: string delete_branch_on_merge: type: boolean subscribers_count: type: integer network_count: type: integer code_of_conduct: "$ref": "#/components/schemas/code-of-conduct" license: type: object properties: key: type: string name: type: string spdx_id: type: string url: type: string node_id: type: string nullable: true forks: type: integer example: 0 open_issues: type: integer example: 0 watchers: type: integer example: 0 allow_forking: type: boolean web_commit_signoff_required: type: boolean example: false security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" custom_properties: type: object description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url thread: title: Thread description: Thread type: object properties: id: type: string repository: "$ref": "#/components/schemas/minimal-repository" subject: type: object properties: title: type: string url: type: string latest_comment_url: type: string type: type: string required: - title - url - latest_comment_url - type reason: type: string unread: type: boolean updated_at: type: string last_read_at: type: string nullable: true url: type: string subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription required: - id - unread - reason - updated_at - last_read_at - subject - repository - url - subscription_url thread-subscription: title: Thread Subscription description: Thread Subscription type: object properties: subscribed: type: boolean example: true ignored: type: boolean reason: type: string nullable: true created_at: type: string format: date-time example: '2012-10-06T21:34:12Z' nullable: true url: type: string format: uri example: https://api.github.com/notifications/threads/1/subscription thread_url: type: string format: uri example: https://api.github.com/notifications/threads/1 repository_url: type: string format: uri example: https://api.github.com/repos/1 required: - created_at - ignored - reason - url - subscribed organization-custom-repository-role: title: Organization Custom Repository Role description: Custom repository roles created by organization owners type: object properties: id: description: The unique identifier of the custom role. type: integer name: description: The name of the custom role. type: string description: description: A short description about who this role is for or what permissions it grants. type: string nullable: true base_role: type: string description: The system role from which this role inherits permissions. enum: - read - triage - write - maintain permissions: description: A list of additional permissions included in this role. type: array items: type: string organization: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - name - base_role - permissions - organization - created_at - updated_at nullable-simple-repository: title: Simple Repository description: A GitHub repository. type: object properties: id: type: integer format: int64 example: 1296269 description: A unique identifier of the repository. node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 description: The GraphQL identifier of the repository. name: type: string example: Hello-World description: The name of the repository. full_name: type: string example: octocat/Hello-World description: The full, globally unique, name of the repository. owner: "$ref": "#/components/schemas/simple-user" private: type: boolean description: Whether the repository is private. html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: The URL to view the repository on GitHub.com. description: type: string example: This your first repo! nullable: true description: The repository description. fork: type: boolean description: Whether the repository is a fork. url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World description: The URL to get more information about the repository from the GitHub API. archive_url: type: string example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} description: A template for the API URL to download the repository as an archive. assignees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} description: A template for the API URL to list the available assignees for issues in the repository. blobs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} description: A template for the API URL to create or retrieve a raw Git blob in the repository. branches_url: type: string example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} description: A template for the API URL to get information about branches in the repository. collaborators_url: type: string example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} description: A template for the API URL to get information about collaborators of the repository. comments_url: type: string example: https://api.github.com/repos/octocat/Hello-World/comments{/number} description: A template for the API URL to get information about comments on the repository. commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} description: A template for the API URL to get information about commits on the repository. compare_url: type: string example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} description: A template for the API URL to compare two commits or refs. contents_url: type: string example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} description: A template for the API URL to get the contents of the repository. contributors_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/contributors description: A template for the API URL to list the contributors to the repository. deployments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/deployments description: The API URL to list the deployments of the repository. downloads_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/downloads description: The API URL to list the downloads on the repository. events_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/events description: The API URL to list the events of the repository. forks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/forks description: The API URL to list the forks of the repository. git_commits_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} description: A template for the API URL to get information about Git commits of the repository. git_refs_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} description: A template for the API URL to get information about Git refs of the repository. git_tags_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} description: A template for the API URL to get information about Git tags of the repository. issue_comment_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} description: A template for the API URL to get information about issue comments on the repository. issue_events_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} description: A template for the API URL to get information about issue events on the repository. issues_url: type: string example: https://api.github.com/repos/octocat/Hello-World/issues{/number} description: A template for the API URL to get information about issues on the repository. keys_url: type: string example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} description: A template for the API URL to get information about deploy keys on the repository. labels_url: type: string example: https://api.github.com/repos/octocat/Hello-World/labels{/name} description: A template for the API URL to get information about labels of the repository. languages_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/languages description: The API URL to get information about the languages of the repository. merges_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/merges description: The API URL to merge branches in the repository. milestones_url: type: string example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} description: A template for the API URL to get information about milestones of the repository. notifications_url: type: string example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} description: A template for the API URL to get information about notifications on the repository. pulls_url: type: string example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} description: A template for the API URL to get information about pull requests on the repository. releases_url: type: string example: https://api.github.com/repos/octocat/Hello-World/releases{/id} description: A template for the API URL to get information about releases on the repository. stargazers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/stargazers description: The API URL to list the stargazers on the repository. statuses_url: type: string example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} description: A template for the API URL to get information about statuses of a commit. subscribers_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscribers description: The API URL to list the subscribers on the repository. subscription_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/subscription description: The API URL to subscribe to notifications for this repository. tags_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/tags description: The API URL to get information about tags on the repository. teams_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/teams description: The API URL to list the teams on the repository. trees_url: type: string example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} description: A template for the API URL to create or retrieve a raw Git tree of the repository. hooks_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url nullable: true dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access in an organization type: object properties: default_level: type: string description: The default repository access level for Dependabot updates. enum: - public - internal example: internal nullable: true accessible_repositories: type: array items: "$ref": "#/components/schemas/nullable-simple-repository" additionalProperties: false billing-premium-request-usage-report-org: type: object properties: timePeriod: type: object properties: year: type: integer description: The year for the usage report. month: type: integer description: The month for the usage report. day: type: integer description: The day for the usage report. required: - year organization: type: string description: The unique identifier of the organization. user: type: string description: The name of the user for the usage report. product: type: string description: The product for the usage report. model: type: string description: The model for the usage report. usageItems: type: array items: type: object properties: product: type: string description: Product name. sku: type: string description: SKU name. model: type: string description: Model name. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossQuantity: type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: type: number description: Net quantity of the usage line item. netAmount: type: number description: Net amount of the usage line item. required: - product - sku - model - unitType - pricePerUnit - grossQuantity - grossAmount - discountQuantity - discountAmount - netQuantity - netAmount required: - timePeriod - organization - usageItems billing-usage-summary-report-org: type: object properties: timePeriod: type: object properties: year: type: integer description: The year for the usage report. month: type: integer description: The month for the usage report. day: type: integer description: The day for the usage report. required: - year organization: type: string description: The unique identifier of the organization. repository: type: string description: The name of the repository for the usage report. product: type: string description: The product for the usage report. sku: type: string description: The SKU for the usage report. usageItems: type: array items: type: object properties: product: type: string description: Product name. sku: type: string description: SKU name. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossQuantity: type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: type: number description: Net quantity of the usage line item. netAmount: type: number description: Net amount of the usage line item. required: - product - sku - unitType - pricePerUnit - grossQuantity - grossAmount - discountQuantity - discountAmount - netQuantity - netAmount required: - timePeriod - organization - usageItems organization-full: title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. Removes non-compliant outside collaborators from the organization and its repositories. GitHub currently defines SMS as an insecure method of two-factor authentication. If your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected. type: object properties: login: type: string example: github id: type: integer example: 1 node_id: type: string example: MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri example: https://api.github.com/orgs/github repos_url: type: string format: uri example: https://api.github.com/orgs/github/repos events_url: type: string format: uri example: https://api.github.com/orgs/github/events hooks_url: type: string example: https://api.github.com/orgs/github/hooks issues_url: type: string example: https://api.github.com/orgs/github/issues members_url: type: string example: https://api.github.com/orgs/github/members{/member} public_members_url: type: string example: https://api.github.com/orgs/github/public_members{/member} avatar_url: type: string example: https://github.com/images/error/octocat_happy.gif description: type: string example: A great organization nullable: true name: type: string example: github company: type: string example: GitHub blog: type: string format: uri example: https://github.com/blog location: type: string example: San Francisco email: type: string format: email example: octocat@github.com twitter_username: type: string example: github nullable: true is_verified: type: boolean example: true has_organization_projects: type: boolean example: true has_repository_projects: type: boolean example: true public_repos: type: integer example: 2 public_gists: type: integer example: 1 followers: type: integer example: 20 following: type: integer example: 0 html_url: type: string format: uri example: https://github.com/octocat type: type: string example: Organization total_private_repos: type: integer example: 100 owned_private_repos: type: integer example: 100 private_gists: type: integer example: 81 nullable: true disk_usage: type: integer example: 10000 nullable: true collaborators: type: integer example: 8 nullable: true description: |- The number of collaborators on private repositories. This field may be null if the number of private repositories is over 50,000. billing_email: type: string format: email example: org@example.com nullable: true plan: type: object properties: name: type: string space: type: integer private_repos: type: integer filled_seats: type: integer seats: type: integer required: - name - space - private_repos default_repository_permission: type: string nullable: true default_repository_branch: type: string example: main nullable: true description: The default branch for repositories created in this organization. members_can_create_repositories: type: boolean example: true nullable: true two_factor_requirement_enabled: type: boolean example: true nullable: true members_allowed_repository_creation_type: type: string example: all members_can_create_public_repositories: type: boolean example: true members_can_create_private_repositories: type: boolean example: true members_can_create_internal_repositories: type: boolean example: true members_can_create_pages: type: boolean example: true members_can_create_public_pages: type: boolean example: true members_can_create_private_pages: type: boolean example: true members_can_delete_repositories: type: boolean example: true members_can_change_repo_visibility: type: boolean example: true members_can_invite_outside_collaborators: type: boolean example: true members_can_delete_issues: type: boolean example: true display_commenter_full_name_setting_enabled: type: boolean example: true readers_can_create_discussions: type: boolean example: true members_can_create_teams: type: boolean example: true members_can_view_dependency_insights: type: boolean example: true members_can_fork_private_repositories: type: boolean example: false nullable: true web_commit_signoff_required: type: boolean example: false advanced_security_enabled_for_new_repositories: type: boolean example: false description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. deprecated: true dependabot_alerts_enabled_for_new_repositories: type: boolean example: false description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. deprecated: true dependabot_security_updates_enabled_for_new_repositories: type: boolean example: false description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. deprecated: true dependency_graph_enabled_for_new_repositories: type: boolean example: false description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. deprecated: true secret_scanning_enabled_for_new_repositories: type: boolean example: false description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. deprecated: true secret_scanning_push_protection_enabled_for_new_repositories: type: boolean example: false description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role. deprecated: true secret_scanning_push_protection_custom_link_enabled: type: boolean example: false description: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. secret_scanning_push_protection_custom_link: type: string example: https://github.com/test-org/test-repo/blob/main/README.md nullable: true description: An optional URL string to display to contributors who are blocked from pushing a secret. secret_scanning_validity_checks_enabled: type: boolean example: false description: |- **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. deprecated: true created_at: type: string format: date-time example: '2008-01-14T04:33:35Z' updated_at: type: string format: date-time archived_at: type: string format: date-time nullable: true deploy_keys_enabled_for_repositories: type: boolean example: false description: Controls whether or not deploy keys may be added and used for repositories in the organization. required: - login - url - id - node_id - repos_url - events_url - hooks_url - issues_url - members_url - public_members_url - avatar_url - description - html_url - has_organization_projects - has_repository_projects - public_repos - public_gists - followers - following - type - created_at - updated_at - archived_at actions-cache-usage-by-repository: title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object properties: full_name: description: The repository owner and name for the cache usage being shown. type: string example: octo-org/Hello-World active_caches_size_in_bytes: description: The sum of the size in bytes of all the active cache items in the repository. type: integer example: 2322142 active_caches_count: description: The number of active caches in the repository. type: integer example: 3 required: - full_name - active_caches_size_in_bytes - active_caches_count oidc-custom-sub: title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object properties: include_claim_keys: description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. type: array items: type: string required: - include_claim_keys empty-object: title: Empty Object description: An object without any properties. type: object properties: {} additionalProperties: false enabled-repositories: type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. enum: - all - none - selected actions-organization-permissions: type: object properties: enabled_repositories: "$ref": "#/components/schemas/enabled-repositories" selected_repositories_url: type: string description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: "$ref": "#/components/schemas/allowed-actions" selected_actions_url: "$ref": "#/components/schemas/selected-actions-url" sha_pinning_required: "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_repositories self-hosted-runners-settings: type: object required: - enabled_repositories properties: enabled_repositories: type: string description: The policy that controls whether self-hosted runners can be used by repositories in the organization enum: - all - selected - none selected_repositories_url: type: string description: The URL to the endpoint for managing selected repositories for self-hosted runners in the organization runner-groups-org: type: object properties: id: type: number name: type: string visibility: type: string default: type: boolean selected_repositories_url: description: Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` type: string runners_url: type: string hosted_runners_url: type: string network_configuration_id: description: The identifier of a hosted compute network configuration. type: string inherited: type: boolean inherited_allows_public_repositories: type: boolean allows_public_repositories: type: boolean workflow_restrictions_read_only: description: If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. type: boolean default: false restricted_to_workflows: description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. type: boolean default: false selected_workflows: description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. type: array items: type: string description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main required: - id - name - visibility - default - runners_url - inherited - allows_public_repositories organization-actions-secret: title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object properties: name: description: The name of the secret. example: SECRET_TOKEN type: string created_at: type: string format: date-time updated_at: type: string format: date-time visibility: description: Visibility of a secret enum: - all - private - selected type: string selected_repositories_url: type: string format: uri example: https://api.github.com/organizations/org/secrets/my_secret/repositories required: - name - created_at - updated_at - visibility actions-public-key: title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object properties: key_id: description: The identifier for the key. type: string example: '1234567' key: description: The Base64 encoded public key. type: string example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= id: type: integer example: 2 url: type: string example: https://api.github.com/user/keys/2 title: type: string example: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: type: string example: '2011-01-26T19:01:12Z' required: - key_id - key organization-actions-variable: title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object properties: name: description: The name of the variable. example: USERNAME type: string value: description: The value of the variable. example: octocat type: string created_at: description: The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. example: '2019-01-24T22:45:36.000Z' type: string format: date-time updated_at: description: The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. example: '2019-01-24T22:45:36.000Z' type: string format: date-time visibility: description: Visibility of a variable enum: - all - private - selected type: string selected_repositories_url: type: string format: uri example: https://api.github.com/organizations/org/variables/USERNAME/repositories required: - name - value - created_at - updated_at - visibility artifact-deployment-record: title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object properties: id: type: integer digest: type: string logical_environment: type: string physical_environment: type: string cluster: type: string deployment_name: type: string tags: type: object additionalProperties: type: string runtime_risks: type: array description: A list of runtime risks associated with the deployment. maxItems: 4 uniqueItems: true items: type: string enum: - critical-resource - internet-exposed - lateral-movement - sensitive-data created_at: type: string updated_at: type: string attestation_id: type: integer description: The ID of the provenance attestation associated with the deployment record. nullable: true campaign-state: title: Campaign state description: Indicates whether a campaign is open or closed type: string enum: - open - closed campaign-alert-type: title: Campaign alert type description: Indicates the alert type of a campaign type: string enum: - code_scanning - secret_scanning campaign-summary: title: Campaign summary description: The campaign metadata and alert stats. type: object properties: number: type: integer description: The number of the newly created campaign created_at: type: string format: date-time description: The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. updated_at: type: string format: date-time description: The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. name: type: string description: The campaign name description: type: string description: The campaign description managers: description: The campaign managers type: array items: "$ref": "#/components/schemas/simple-user" team_managers: description: The campaign team managers type: array items: "$ref": "#/components/schemas/team" published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time ends_at: description: The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time closed_at: description: The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. type: string format: date-time nullable: true state: "$ref": "#/components/schemas/campaign-state" contact_link: description: The contact link of the campaign. type: string format: uri nullable: true alert_stats: type: object additionalProperties: false properties: open_count: type: integer description: The number of open alerts closed_count: type: integer description: The number of closed alerts in_progress_count: type: integer description: The number of in-progress alerts required: - open_count - closed_count - in_progress_count required: - number - created_at - updated_at - description - managers - ends_at - state - contact_link code-scanning-alert-severity: type: string description: Severity of a code scanning alert. enum: - critical - high - medium - low - warning - note - error nullable-codespace-machine: type: object title: Codespace machine description: A description of the machine powering a codespace. properties: name: type: string description: The name of the machine. example: standardLinux display_name: type: string description: The display name of the machine includes cores, memory, and storage. example: 4 cores, 16 GB RAM, 64 GB storage operating_system: type: string description: The operating system of the machine. example: linux storage_in_bytes: type: integer description: How much storage is available to the codespace. example: 68719476736 memory_in_bytes: type: integer description: How much memory is available to the codespace. example: 17179869184 cpus: type: integer description: How many cores are available to the codespace. example: 4 prebuild_availability: type: string description: Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. example: ready enum: - none - ready - in_progress nullable: true required: - name - display_name - operating_system - storage_in_bytes - memory_in_bytes - cpus - prebuild_availability nullable: true codespace: type: object title: Codespace description: A codespace. properties: id: type: integer format: int64 example: 1 name: description: Automatically generated name of this codespace. type: string example: monalisa-octocat-hello-world-g4wpq6h95q display_name: description: Display name for this codespace. type: string example: bookish space pancake nullable: true environment_id: description: UUID identifying this codespace's environment. type: string example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 nullable: true owner: "$ref": "#/components/schemas/simple-user" billable_owner: "$ref": "#/components/schemas/simple-user" repository: "$ref": "#/components/schemas/minimal-repository" machine: "$ref": "#/components/schemas/nullable-codespace-machine" devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. type: string example: ".devcontainer/example/devcontainer.json" nullable: true prebuild: description: Whether the codespace was created from a prebuild. type: boolean example: false nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:01:12Z' last_used_at: description: Last known time this codespace was started. type: string format: date-time example: '2011-01-26T19:01:12Z' state: description: State of this codespace. enum: - Unknown - Created - Queued - Provisioning - Available - Awaiting - Unavailable - Deleted - Moved - Shutdown - Archived - Starting - ShuttingDown - Failed - Exporting - Updating - Rebuilding example: Available type: string url: description: API URL for this codespace. type: string format: uri git_status: description: Details about the codespace's git repository. type: object properties: ahead: description: The number of commits the local repository is ahead of the remote. type: integer example: 0 behind: description: The number of commits the local repository is behind the remote. type: integer example: 0 has_unpushed_changes: description: Whether the local repository has unpushed changes. type: boolean has_uncommitted_changes: description: Whether the local repository has uncommitted changes. type: boolean ref: description: The current branch (or SHA if in detached HEAD state) of the local repository. type: string example: main location: description: The initally assigned location of a new codespace. enum: - EastUs - SouthEastAsia - WestEurope - WestUs2 example: WestUs2 type: string idle_timeout_minutes: description: The number of minutes of inactivity after which this codespace will be automatically stopped. type: integer example: 60 nullable: true web_url: description: URL to access this codespace on the web. type: string format: uri machines_url: description: API URL to access available alternate machine types for this codespace. type: string format: uri start_url: description: API URL to start this codespace. type: string format: uri stop_url: description: API URL to stop this codespace. type: string format: uri publish_url: description: API URL to publish this codespace to a new repository. type: string format: uri nullable: true pulls_url: description: API URL for the Pull Request associated with this codespace, if any. type: string format: uri nullable: true recent_folders: type: array items: type: string runtime_constraints: type: object properties: allowed_port_privacy_settings: description: The privacy settings a user can select from when forwarding a port. type: array items: type: string nullable: true pending_operation: description: Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. type: boolean nullable: true pending_operation_disabled_reason: description: Text to show user when codespace is disabled by a pending operation type: string nullable: true idle_timeout_notice: description: Text to show user when codespace idle timeout minutes has been overriden by an organization policy type: string nullable: true retention_period_minutes: description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). type: integer example: 60 nullable: true retention_expires_at: description: When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" type: string format: date-time example: '2011-01-26T20:01:12Z' nullable: true last_known_stop_notice: description: The text to display to a user when a codespace has been stopped for a potentially actionable reason. type: string example: you've used 100% of your spending limit for Codespaces nullable: true required: - id - name - environment_id - owner - billable_owner - repository - machine - prebuild - created_at - updated_at - last_used_at - state - url - git_status - location - idle_timeout_minutes - web_url - machines_url - start_url - stop_url - pulls_url - recent_folders codespaces-org-secret: title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object properties: name: description: The name of the secret example: SECRET_NAME type: string created_at: description: The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time updated_at: description: The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time visibility: description: The type of repositories in the organization that the secret is visible to enum: - all - private - selected type: string selected_repositories_url: description: The API URL at which the list of repositories this secret is visible to can be retrieved type: string format: uri example: https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories required: - name - created_at - updated_at - visibility codespaces-public-key: title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object properties: key_id: description: The identifier for the key. type: string example: '1234567' key: description: The Base64 encoded public key. type: string example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= id: type: integer example: 2 url: type: string example: https://api.github.com/user/keys/2 title: type: string example: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: type: string example: '2011-01-26T19:01:12Z' required: - key_id - key copilot-organization-seat-breakdown: title: Copilot Seat Breakdown description: The breakdown of Copilot Business seats for the organization. type: object properties: total: type: integer description: The total number of seats being billed for the organization as of the current billing cycle. added_this_cycle: type: integer description: Seats added during the current billing cycle. pending_cancellation: type: integer description: The number of seats that are pending cancellation at the end of the current billing cycle. pending_invitation: type: integer description: The number of users who have been invited to receive a Copilot seat through this organization. active_this_cycle: type: integer description: The number of seats that have used Copilot during the current billing cycle. inactive_this_cycle: type: integer description: The number of seats that have not used Copilot during the current billing cycle. copilot-organization-details: title: Copilot Organization Details description: Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. type: object properties: seat_breakdown: "$ref": "#/components/schemas/copilot-organization-seat-breakdown" public_code_suggestions: type: string description: The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). enum: - allow - block - unconfigured ide_chat: type: string description: The organization policy for allowing or disallowing Copilot Chat in the IDE. enum: - enabled - disabled - unconfigured platform_chat: type: string description: The organization policy for allowing or disallowing Copilot features on GitHub.com. enum: - enabled - disabled - unconfigured cli: type: string description: The organization policy for allowing or disallowing Copilot in the CLI. enum: - enabled - disabled - unconfigured seat_management_setting: type: string description: The mode of assigning new seats. enum: - assign_all - assign_selected - disabled - unconfigured plan_type: type: string description: The Copilot plan of the organization, or the parent enterprise, when applicable. enum: - business - enterprise required: - seat_breakdown - public_code_suggestions - seat_management_setting additionalProperties: true credential-authorization: title: Credential Authorization description: Credential Authorization type: object properties: login: type: string example: monalisa description: User login that owns the underlying credential. credential_id: type: integer example: 1 description: Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key. credential_type: type: string example: SSH Key description: Human-readable description of the credential type. token_last_eight: type: string example: '12345678' description: Last eight characters of the credential. Only included in responses with credential_type of personal access token. credential_authorized_at: type: string format: date-time example: '2011-01-26T19:06:43Z' description: Date when the credential was authorized for use. scopes: type: array example: - user - repo description: List of oauth scopes the token has been granted. items: type: string fingerprint: type: string example: jklmnop12345678 description: Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. credential_accessed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' description: Date when the credential was last accessed. May be null if it was never accessed nullable: true authorized_credential_id: type: integer nullable: true example: 12345678 description: The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token. authorized_credential_title: type: string nullable: true example: my ssh key description: The title given to the ssh key. This will only be present when the credential is an ssh key. authorized_credential_note: type: string nullable: true example: my token description: The note given to the token. This will only be present when the credential is a token. authorized_credential_expires_at: type: string format: date-time nullable: true description: The expiry for the token. This will only be present when the credential is a token. required: - login - credential_id - credential_type - credential_authorized_at - credential_accessed_at - authorized_credential_id organization-custom-repository-role-create-schema: type: object properties: name: description: The name of the custom role. type: string description: description: A short description about who this role is for or what permissions it grants. type: string nullable: true base_role: type: string description: The system role from which this role inherits permissions. enum: - read - triage - write - maintain permissions: description: A list of additional permissions included in this role. type: array items: type: string required: - name - base_role - permissions organization-custom-repository-role-update-schema: type: object properties: name: description: The name of the custom role. type: string description: description: A short description about who this role is for or what permissions it grants. type: string nullable: true base_role: type: string description: The system role from which this role inherits permissions. enum: - read - triage - write - maintain permissions: description: A list of additional permissions included in this role. type: array items: type: string organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object properties: name: description: The name of the secret. example: SECRET_TOKEN type: string created_at: type: string format: date-time updated_at: type: string format: date-time visibility: description: Visibility of a secret enum: - all - private - selected type: string selected_repositories_url: type: string format: uri example: https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories required: - name - created_at - updated_at - visibility dependabot-public-key: title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object properties: key_id: description: The identifier for the key. type: string example: '1234567' key: description: The Base64 encoded public key. type: string example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= required: - key_id - key dismissal-request-response: title: Dismissal request response description: A response made by a requester to dismiss the request. type: object properties: id: type: integer format: int64 description: The ID of the response to the dismissal request. reviewer: type: object description: The user who reviewed the dismissal request. properties: actor_id: type: integer format: int64 description: The ID of the GitHub user who reviewed the dismissal request. actor_name: type: string description: The name of the GitHub user who reviewed the dismissal request. message: type: string nullable: true description: The response comment of the reviewer. status: type: string description: The response status to the dismissal request until dismissed. enum: - approved - denied - dismissed created_at: type: string format: date-time description: The date and time the response to the dismissal request was created. code-scanning-alert-dismissal-request: title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. type: object properties: id: type: integer format: int64 description: The unique identifier of the dismissal request. number: type: integer format: int64 description: The number uniquely identifying the dismissal request within its repository. repository: type: object description: The repository the dismissal request is for. properties: id: type: integer format: int64 description: The ID of the repository the dismissal request is for. name: type: string description: The name of the repository the dismissal request is for. full_name: type: string description: The full name of the repository the dismissal request is for. organization: type: object description: The organization associated with the repository the dismissal request is for. properties: id: type: integer format: int64 description: The ID of the organization. name: type: string description: The name of the organization. requester: type: object description: The user who requested the dismissal request. properties: actor_id: type: integer format: int64 description: The ID of the GitHub user who requested the dismissal request. actor_name: type: string description: The name of the GitHub user who requested the dismissal request. request_type: type: string description: The type of request. data: nullable: true type: array description: Data describing the dismissal request metadata. items: type: object properties: reason: type: string description: The reason for the dismissal request. alert_number: type: string description: alert number. pr_review_thread_id: type: string description: The ID of the pull request review thread. resource_identifier: type: string description: The unique identifier for the request type of the dismissal request. example: 827efc6d56897b048c772eb4087f854f46256132 status: type: string description: The status of the dismissal request. enum: - pending - denied - approved - expired requester_comment: type: string description: The comment the requester provided when creating the dismissal request. nullable: true expires_at: type: string format: date-time description: The date and time the dismissal request will expire. created_at: type: string format: date-time description: The date and time the dismissal request was created. responses: type: array description: The responses to the dismissal request. nullable: true items: "$ref": "#/components/schemas/dismissal-request-response" url: type: string format: uri example: https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1 html_url: type: string description: The URL to view the dismissal request in a browser. format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 secret-scanning-dismissal-request: title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. type: object properties: id: type: integer description: The unique identifier of the dismissal request. number: type: integer description: The number uniquely identifying the dismissal request within its repository. repository: type: object description: The repository the dismissal request is for. properties: id: type: integer description: The ID of the repository the dismissal request is for. name: type: string description: The name of the repository the dismissal request is for. full_name: type: string description: The full name of the repository the dismissal request is for. organization: type: object description: The organization associated with the repository the dismissal request is for. properties: id: type: integer description: The ID of the organization. name: type: string description: The name of the organization. requester: type: object description: The user who requested the dismissal. properties: actor_id: type: integer description: The ID of the GitHub user who requested the dismissal. actor_name: type: string description: The name of the GitHub user who requested the dismissal. request_type: type: string description: The type of request. data: nullable: true type: array description: Data describing the secret alert that is being requested to be dismissed. items: type: object properties: secret_type: type: string description: The type of secret that secret scanning detected. alert_number: type: string description: The number of the secret scanning alert that was detected. reason: type: string description: The reason the user provided for requesting the dismissal. enum: - fixed_later - false_positive - tests - revoked resource_identifier: type: string description: The number of the secret scanning alert that was detected. example: 1234 status: type: string description: The status of the dismissal request. enum: - pending - denied - approved - cancelled - expired requester_comment: type: string description: The comment the requester provided when creating the dismissal request. nullable: true expires_at: type: string format: date-time description: The date and time the dismissal request will expire. created_at: type: string format: date-time description: The date and time the dismissal request was created. responses: type: array description: The responses to the dismissal request. nullable: true items: "$ref": "#/components/schemas/bypass-response" url: type: string format: uri example: https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/1 html_url: type: string description: The URL to view the dismissal request in a browser. format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 nullable-minimal-repository: title: Minimal Repository description: Minimal Repository type: object properties: id: type: integer format: int64 example: 1296269 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: type: string example: Hello-World full_name: type: string example: octocat/Hello-World owner: "$ref": "#/components/schemas/simple-user" private: type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string mirror_url: type: string nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string homepage: type: string nullable: true language: type: string nullable: true forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer default_branch: type: string open_issues_count: type: integer is_template: type: boolean topics: type: array items: type: string has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_downloads: type: boolean has_discussions: type: boolean archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean role_name: type: string example: admin temp_clone_token: type: string delete_branch_on_merge: type: boolean subscribers_count: type: integer network_count: type: integer code_of_conduct: "$ref": "#/components/schemas/code-of-conduct" license: type: object properties: key: type: string name: type: string spdx_id: type: string url: type: string node_id: type: string nullable: true forks: type: integer example: 0 open_issues: type: integer example: 0 watchers: type: integer example: 0 allow_forking: type: boolean web_commit_signoff_required: type: boolean example: false security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" custom_properties: type: object description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url nullable: true package: title: Package description: A software package type: object properties: id: description: Unique identifier of the package. type: integer example: 1 name: description: The name of the package. type: string example: super-linter package_type: type: string example: docker enum: - npm - maven - rubygems - docker - nuget - container url: type: string example: https://api.github.com/orgs/github/packages/container/super-linter html_url: type: string example: https://github.com/orgs/github/packages/container/package/super-linter version_count: description: The number of versions of the package. type: integer example: 1 visibility: type: string example: private enum: - private - public owner: "$ref": "#/components/schemas/nullable-simple-user" repository: "$ref": "#/components/schemas/nullable-minimal-repository" created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - name - package_type - visibility - url - html_url - version_count - created_at - updated_at external-group: title: ExternalGroup description: Information about an external group's usage and its members type: object required: - group_id - group_name - teams - members properties: group_id: description: The internal ID of the group example: 1 type: integer group_name: description: The display name for the group example: group-azuread-test type: string updated_at: description: The date when the group was last updated_at example: 2021-01-03 22:27:15:000 -700 type: string teams: description: An array of teams linked to this group example: - team_id: 1 team_name: team-test - team_id: 2 team_name: team-test2 type: array items: type: object required: - team_id - team_name properties: team_id: description: The id for a team example: 1 type: integer team_name: description: The name of the team example: team-test type: string members: description: An array of external members linked to this group example: - member_id: 1 member_login: mona-lisa_eocsaxrs member_name: Mona Lisa member_email: mona_lisa@github.com - member_id: 2 member_login: octo-lisa_eocsaxrs member_name: Octo Lisa member_email: octo_lisa@github.com type: array items: type: object required: - member_id - member_login - member_name - member_email properties: member_id: description: The internal user ID of the identity example: 1 type: integer member_login: description: The handle/login for the user example: mona-lisa_eocsaxrs type: string member_name: description: The user display name/profile name example: Mona Lisa type: string member_email: description: An email attached to a user example: mona_lisa@github.com type: string external-groups: title: ExternalGroups description: A list of external groups available to be connected to a team type: object properties: groups: description: An array of external groups available to be mapped to a team example: - group_id: 1 group_name: group-azuread-test updated_at: 2021-01-03 22:27:15:000 -700 - group_id: 2 group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 type: array items: type: object required: - group_id - group_name - updated_at properties: group_id: description: The internal ID of the group example: 1 type: integer group_name: description: The display name of the group example: group-azuread-test type: string updated_at: description: The time of the last update for this group example: 2019-06-03 22:27:15:000 -700 type: string organization-invitation: title: Organization Invitation description: Organization Invitation type: object properties: id: type: integer format: int64 login: type: string nullable: true email: type: string nullable: true role: type: string created_at: type: string failed_at: type: string nullable: true failed_reason: type: string nullable: true inviter: "$ref": "#/components/schemas/simple-user" team_count: type: integer node_id: type: string example: '"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x"' invitation_teams_url: type: string example: '"https://api.github.com/organizations/16/invitations/1/teams"' invitation_source: type: string example: '"member"' required: - id - login - email - role - created_at - inviter - team_count - invitation_teams_url - node_id repository-fine-grained-permission: title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. type: object properties: name: type: string description: type: string required: - name - description org-hook: title: Org Hook description: Org Hook type: object properties: id: type: integer example: 1 url: type: string format: uri example: https://api.github.com/orgs/octocat/hooks/1 ping_url: type: string format: uri example: https://api.github.com/orgs/octocat/hooks/1/pings deliveries_url: type: string format: uri example: https://api.github.com/orgs/octocat/hooks/1/deliveries name: type: string example: web events: type: array example: - push - pull_request items: type: string active: type: boolean example: true config: type: object properties: url: type: string example: '"http://example.com/2"' insecure_ssl: type: string example: '"0"' content_type: type: string example: '"form"' secret: type: string example: '"********"' updated_at: type: string format: date-time example: '2011-09-06T20:39:23Z' created_at: type: string format: date-time example: '2011-09-06T17:26:27Z' type: type: string required: - id - url - type - name - active - events - config - ping_url - created_at - updated_at api-insights-route-stats: title: Route Stats description: API Insights usage route stats for an actor type: array items: type: object properties: http_method: description: The HTTP method type: string api_route: description: The API path's route template type: string total_request_count: description: The total number of requests within the queried time period type: integer format: int64 rate_limited_request_count: description: The total number of requests that were rate limited within the queried time period type: integer format: int64 last_rate_limited_timestamp: type: string nullable: true last_request_timestamp: type: string api-insights-subject-stats: title: Subject Stats description: API Insights usage subject stats for an organization type: array items: type: object properties: subject_type: type: string subject_name: type: string subject_id: type: integer format: int64 total_request_count: type: integer rate_limited_request_count: type: integer last_rate_limited_timestamp: type: string nullable: true last_request_timestamp: type: string api-insights-summary-stats: title: Summary Stats description: API Insights usage summary stats for an organization type: object properties: total_request_count: description: The total number of requests within the queried time period type: integer format: int64 rate_limited_request_count: description: The total number of requests that were rate limited within the queried time period type: integer format: int64 api-insights-time-stats: title: Time Stats description: API Insights usage time stats for an organization type: array items: type: object properties: timestamp: type: string total_request_count: type: integer format: int64 rate_limited_request_count: type: integer format: int64 api-insights-user-stats: title: User Stats description: API Insights usage stats for a user type: array items: type: object properties: actor_type: type: string actor_name: type: string actor_id: type: integer format: int64 integration_id: type: integer format: int64 nullable: true oauth_application_id: type: integer format: int64 nullable: true total_request_count: type: integer rate_limited_request_count: type: integer last_rate_limited_timestamp: type: string nullable: true last_request_timestamp: type: string interaction-group: type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. example: collaborators_only enum: - existing_users - contributors_only - collaborators_only interaction-limit-response: title: Interaction Limits description: Interaction limit settings. type: object properties: limit: "$ref": "#/components/schemas/interaction-group" origin: type: string example: repository expires_at: type: string format: date-time example: '2018-08-17T04:18:39Z' required: - limit - origin - expires_at interaction-expiry: type: string description: 'The duration of the interaction restriction. Default: `one_day`.' example: one_month enum: - one_day - three_days - one_week - one_month - six_months interaction-limit: title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: limit: "$ref": "#/components/schemas/interaction-group" expiry: "$ref": "#/components/schemas/interaction-expiry" required: - limit organization-create-issue-type: type: object properties: name: description: Name of the issue type. type: string is_enabled: description: Whether or not the issue type is enabled at the organization level. type: boolean description: description: Description of the issue type. type: string nullable: true color: description: Color for the issue type. type: string enum: - gray - blue - green - yellow - orange - red - pink - purple nullable: true required: - name - is_enabled organization-update-issue-type: type: object properties: name: description: Name of the issue type. type: string is_enabled: description: Whether or not the issue type is enabled at the organization level. type: boolean description: description: Description of the issue type. type: string nullable: true color: description: Color for the issue type. type: string enum: - gray - blue - green - yellow - orange - red - pink - purple nullable: true required: - name - is_enabled org-membership: title: Org Membership description: Org Membership type: object properties: url: type: string format: uri example: https://api.github.com/orgs/octocat/memberships/defunkt state: type: string description: The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. example: active enum: - active - pending role: type: string description: The user's membership type in the organization. example: admin enum: - admin - member - billing_manager direct_membership: type: boolean description: Whether the user has direct membership in the organization. example: true enterprise_teams_providing_indirect_membership: type: array description: |- The slugs of the enterprise teams providing the user with indirect membership in the organization. A limit of 100 enterprise team slugs is returned. maxItems: 100 items: type: string example: - ent:team-one - ent:team-two organization_url: type: string format: uri example: https://api.github.com/orgs/octocat organization: "$ref": "#/components/schemas/organization-simple" user: "$ref": "#/components/schemas/nullable-simple-user" permissions: type: object properties: can_create_repository: type: boolean required: - can_create_repository required: - state - role - organization_url - url - organization - user migration: title: Migration description: A migration. type: object properties: id: type: integer format: int64 example: 79 owner: "$ref": "#/components/schemas/nullable-simple-user" guid: type: string example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 state: type: string example: pending lock_repositories: type: boolean example: true exclude_metadata: type: boolean exclude_git_data: type: boolean exclude_attachments: type: boolean exclude_releases: type: boolean exclude_owner_projects: type: boolean org_metadata_only: type: boolean repositories: type: array description: The repositories included in the migration. Only returned for export migrations. items: "$ref": "#/components/schemas/repository" url: type: string format: uri example: https://api.github.com/orgs/octo-org/migrations/79 created_at: type: string format: date-time example: '2015-07-06T15:33:38-07:00' updated_at: type: string format: date-time example: '2015-07-06T15:33:38-07:00' node_id: type: string archive_url: type: string format: uri exclude: description: 'Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.' type: array items: description: 'Allowed values that can be passed to the exclude parameter. The array can include any of: `"repositories"`.' type: string required: - id - node_id - owner - guid - state - lock_repositories - exclude_metadata - exclude_git_data - exclude_attachments - exclude_releases - exclude_owner_projects - org_metadata_only - repositories - url - created_at - updated_at organization-fine-grained-permission: title: Organization Fine-Grained Permission description: A fine-grained permission that protects organization resources. type: object properties: name: type: string description: type: string required: - name - description organization-role: title: Organization Role description: Organization roles type: object properties: id: description: The unique identifier of the role. type: integer format: int64 name: description: The name of the role. type: string description: description: A short description about who this role is for or what permissions it grants. type: string nullable: true base_role: type: string nullable: true description: The system role from which this role inherits permissions. enum: - read - triage - write - maintain - admin source: type: string nullable: true description: Source answers the question, "where did this role come from?" enum: - Organization - Enterprise - Predefined permissions: description: A list of permissions included in this role. type: array items: type: string organization: "$ref": "#/components/schemas/nullable-simple-user" created_at: description: The date and time the role was created. type: string format: date-time updated_at: description: The date and time the role was last updated. type: string format: date-time required: - id - name - permissions - organization - created_at - updated_at organization-custom-organization-role-create-schema: type: object properties: name: description: The name of the custom role. type: string description: description: A short description about the intended usage of this role or what permissions it grants. type: string permissions: description: A list of additional permissions included in this role. type: array items: type: string base_role: description: The system role from which this role can inherit permissions. type: string enum: - read - triage - write - maintain - admin required: - name - permissions organization-custom-organization-role-update-schema: type: object properties: name: description: The name of the custom role. type: string description: description: A short description about the intended use of this role or the permissions it grants. type: string permissions: description: A list of additional permissions included in this role. type: array items: type: string base_role: description: The system role from which this role can inherit permissions. type: string enum: - none - read - triage - write - maintain - admin team-role-assignment: title: A Role Assignment for a Team description: The Relationship a Team has with a role. type: object properties: assignment: type: string description: Determines if the team has a direct, indirect, or mixed relationship to a role enum: - direct - indirect - mixed example: direct id: type: integer node_id: type: string name: type: string slug: type: string description: type: string nullable: true privacy: type: string notification_setting: type: string permission: type: string permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - triage - push - maintain - admin url: type: string format: uri html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core members_url: type: string repositories_url: type: string format: uri parent: "$ref": "#/components/schemas/nullable-team-simple" type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - type - parent team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: description: Unique identifier of the team type: integer example: 1 node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team type: string format: uri example: https://api.github.com/organizations/1/team/1 members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} name: description: Name of the team type: string example: Justice League description: description: Description of the team type: string nullable: true example: A great team. permission: description: Permission that the team will have for its repositories type: string example: admin privacy: description: The level of privacy this team should have type: string example: closed notification_setting: description: The notification setting the team has set type: string example: notifications_enabled html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos slug: type: string example: justice-league ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - type user-role-assignment: title: A Role Assignment for a User description: The Relationship a User has with a role. type: object properties: assignment: type: string description: Determines if the user has a direct, indirect, or mixed relationship to a role enum: - direct - indirect - mixed example: direct inherited_from: description: Team the user has gotten the role through type: array items: "$ref": "#/components/schemas/team-simple" name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' user_view_type: type: string example: public required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url package-version: title: Package Version description: A version of a software package type: object properties: id: description: Unique identifier of the package version. type: integer example: 1 name: description: The name of the package version. type: string example: latest url: type: string example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 package_html_url: type: string example: https://github.com/orgs/github/packages/container/package/super-linter html_url: type: string example: https://github.com/orgs/github/packages/container/super-linter/786068 license: type: string example: MIT description: type: string created_at: type: string format: date-time example: '2011-04-10T20:09:31Z' updated_at: type: string format: date-time example: '2014-03-03T18:58:10Z' deleted_at: type: string format: date-time example: '2014-03-03T18:58:10Z' metadata: type: object title: Package Version Metadata properties: package_type: type: string example: docker enum: - npm - maven - rubygems - docker - nuget - container container: type: object title: Container Metadata properties: tags: type: array items: type: string required: - tags docker: type: object title: Docker Metadata properties: tag: type: array items: type: string required: - tags required: - package_type required: - id - name - url - package_html_url - created_at - updated_at organization-programmatic-access-grant-request: title: Simple Organization Programmatic Access Grant Request description: Minimal representation of an organization programmatic access grant request for enumerations type: object properties: id: type: integer description: Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. reason: type: string nullable: true description: Reason for requesting access. owner: "$ref": "#/components/schemas/simple-user" repository_selection: type: string enum: - none - all - subset description: Type of repository selection requested. repositories_url: type: string description: URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`. permissions: type: object description: Permissions requested, categorized by type of permission. properties: organization: type: object additionalProperties: type: string repository: type: object additionalProperties: type: string other: type: object additionalProperties: type: string created_at: type: string description: Date and time when the request for access was created. token_id: type: integer description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. token_name: type: string description: The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has expired. token_expires_at: type: string nullable: true description: Date and time when the associated fine-grained personal access token expires. token_last_used_at: type: string nullable: true description: Date and time when the associated fine-grained personal access token was last used for authentication. required: - id - reason - owner - repository_selection - repositories_url - permissions - created_at - token_id - token_name - token_expired - token_expires_at - token_last_used_at organization-programmatic-access-grant: title: Organization Programmatic Access Grant description: Minimal representation of an organization programmatic access grant for enumerations type: object properties: id: type: integer description: Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. owner: "$ref": "#/components/schemas/simple-user" repository_selection: type: string enum: - none - all - subset description: Type of repository selection requested. repositories_url: type: string description: URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`. permissions: type: object description: Permissions requested, categorized by type of permission. properties: organization: type: object additionalProperties: type: string repository: type: object additionalProperties: type: string other: type: object additionalProperties: type: string access_granted_at: type: string description: Date and time when the fine-grained personal access token was approved to access the organization. token_id: type: integer description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. token_name: type: string description: The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has expired. token_expires_at: type: string nullable: true description: Date and time when the associated fine-grained personal access token expires. token_last_used_at: type: string nullable: true description: Date and time when the associated fine-grained personal access token was last used for authentication. required: - id - owner - repository_selection - repositories_url - permissions - access_granted_at - token_id - token_name - token_expired - token_expires_at - token_last_used_at org-private-registry-configuration: title: Organization private registry description: Private registry configuration for an organization type: object properties: name: description: The name of the private registry configuration. example: MAVEN_REPOSITORY_SECRET type: string registry_type: description: The registry type. enum: - maven_repository - nuget_feed - goproxy_server - npm_registry - rubygems_server - cargo_registry - composer_repository - docker_registry - git_source - helm_registry - hex_organization - hex_repository - pub_repository - python_index - terraform_registry type: string url: description: The URL of the private registry. type: string format: uri username: description: The username to use when authenticating with the private registry. example: monalisa type: string nullable: true replaces_base: description: Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. type: boolean default: false visibility: description: Which type of organization repositories have access to the private registry. enum: - all - private - selected type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - name - registry_type - visibility - created_at - updated_at org-private-registry-configuration-with-selected-repositories: title: Organization private registry description: Private registry configuration for an organization type: object properties: name: description: The name of the private registry configuration. example: MAVEN_REPOSITORY_SECRET type: string registry_type: description: The registry type. enum: - maven_repository - nuget_feed - goproxy_server - npm_registry - rubygems_server - cargo_registry - composer_repository - docker_registry - git_source - helm_registry - hex_organization - hex_repository - pub_repository - python_index - terraform_registry type: string url: description: The URL of the private registry. type: string format: uri username: description: The username to use when authenticating with the private registry. example: monalisa type: string replaces_base: description: Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. type: boolean default: false visibility: description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. enum: - all - private - selected type: string selected_repository_ids: type: array description: An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. items: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time required: - name - registry_type - visibility - created_at - updated_at nullable-projects-v2-status-update: title: Projects v2 Status Update description: An status update belonging to a project type: object properties: id: type: number description: The unique identifier of the status update. node_id: type: string description: The node ID of the status update. project_node_id: type: string description: The node ID of the project that this status update belongs to. creator: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the status update was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the status update was last updated. status: type: string enum: - INACTIVE - ON_TRACK - AT_RISK - OFF_TRACK - COMPLETE nullable: true description: The current status. start_date: type: string format: date example: '2022-04-28' description: The start date of the period covered by the update. target_date: type: string format: date example: '2022-04-28' description: The target date associated with the update. body: description: Body of the status update example: The project is off to a great start! type: string nullable: true required: - id - node_id - created_at - updated_at nullable: true projects-v2: title: Projects v2 Project description: A projects v2 project type: object properties: id: type: number description: The unique identifier of the project. node_id: type: string description: The node ID of the project. owner: "$ref": "#/components/schemas/simple-user" creator: "$ref": "#/components/schemas/simple-user" title: type: string description: The project title. description: type: string nullable: true description: A short description of the project. public: type: boolean description: Whether the project is visible to anyone with access to the owner. closed_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true description: The time when the project was closed. created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the project was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the project was last updated. number: type: integer description: The project number. short_description: type: string nullable: true description: A concise summary of the project. deleted_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true description: The time when the project was deleted. deleted_by: "$ref": "#/components/schemas/nullable-simple-user" state: type: string enum: - open - closed description: The current state of the project. latest_status_update: "$ref": "#/components/schemas/nullable-projects-v2-status-update" is_template: type: boolean description: Whether this project is a template required: - id - node_id - owner - creator - title - description - public - closed_at - created_at - updated_at - number - short_description - deleted_at - deleted_by link: title: Link description: Hypermedia Link type: object properties: href: type: string required: - href auto-merge: title: Auto merge description: The status of auto merging a pull request. type: object properties: enabled_by: "$ref": "#/components/schemas/simple-user" merge_method: type: string description: The merge method to use. enum: - merge - squash - rebase commit_title: type: string description: Title for the merge commit message. commit_message: type: string description: Commit message for the merge commit. required: - enabled_by - merge_method - commit_title - commit_message nullable: true pull-request-simple: title: Pull Request Simple description: Pull Request Simple type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer format: int64 example: 1 node_id: type: string example: MDExOlB1bGxSZXF1ZXN0MQ== html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347 diff_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.patch issue_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/1347 commits_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits review_comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments review_comment_url: type: string example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e number: type: integer example: 1347 state: type: string example: open locked: type: boolean example: true title: type: string example: new-feature user: "$ref": "#/components/schemas/nullable-simple-user" body: type: string example: Please pull these awesome changes nullable: true labels: type: array items: type: object properties: id: type: integer format: int64 node_id: type: string url: type: string name: type: string description: type: string color: type: string default: type: boolean required: - id - node_id - url - name - description - color - default milestone: "$ref": "#/components/schemas/nullable-milestone" active_lock_reason: type: string example: too heated nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:01:12Z' closed_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true merged_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true merge_commit_sha: type: string example: e5bd3914e2e596debea16f433f57875b5b90bcd6 nullable: true assignee: "$ref": "#/components/schemas/nullable-simple-user" assignees: type: array items: "$ref": "#/components/schemas/simple-user" nullable: true requested_reviewers: type: array items: "$ref": "#/components/schemas/simple-user" nullable: true requested_teams: type: array items: "$ref": "#/components/schemas/team" nullable: true head: type: object properties: label: type: string ref: type: string repo: "$ref": "#/components/schemas/repository" sha: type: string user: "$ref": "#/components/schemas/nullable-simple-user" required: - label - ref - repo - sha - user base: type: object properties: label: type: string ref: type: string repo: "$ref": "#/components/schemas/repository" sha: type: string user: "$ref": "#/components/schemas/nullable-simple-user" required: - label - ref - repo - sha - user _links: type: object properties: comments: "$ref": "#/components/schemas/link" commits: "$ref": "#/components/schemas/link" statuses: "$ref": "#/components/schemas/link" html: "$ref": "#/components/schemas/link" issue: "$ref": "#/components/schemas/link" review_comments: "$ref": "#/components/schemas/link" review_comment: "$ref": "#/components/schemas/link" self: "$ref": "#/components/schemas/link" required: - comments - commits - statuses - html - issue - review_comments - review_comment - self author_association: "$ref": "#/components/schemas/author-association" auto_merge: "$ref": "#/components/schemas/auto-merge" draft: description: Indicates whether or not the pull request is a draft. example: false type: boolean required: - _links - assignee - labels - base - body - closed_at - comments_url - commits_url - created_at - diff_url - head - html_url - id - node_id - issue_url - merge_commit_sha - merged_at - milestone - number - patch_url - review_comment_url - review_comments_url - statuses_url - state - locked - title - updated_at - url - user - author_association - auto_merge projects-v2-draft-issue: title: Draft Issue description: A draft issue in a project type: object properties: id: type: number description: The ID of the draft issue node_id: type: string description: The node ID of the draft issue title: type: string description: The title of the draft issue body: type: string description: The body content of the draft issue nullable: true user: "$ref": "#/components/schemas/nullable-simple-user" created_at: type: string format: date-time description: The time the draft issue was created updated_at: type: string format: date-time description: The time the draft issue was last updated required: - id - node_id - title - user - created_at - updated_at projects-v2-item-content-type: title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string enum: - Issue - PullRequest - DraftIssue projects-v2-item-simple: title: Projects v2 Item description: An item belonging to a project type: object properties: id: type: number description: The unique identifier of the project item. node_id: type: string description: The node ID of the project item. content: oneOf: - "$ref": "#/components/schemas/issue" - "$ref": "#/components/schemas/pull-request-simple" - "$ref": "#/components/schemas/projects-v2-draft-issue" description: The content represented by the item. content_type: "$ref": "#/components/schemas/projects-v2-item-content-type" creator: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the item was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the item was last updated. archived_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true description: The time when the item was archived. project_url: type: string format: uri description: The URL of the project this item belongs to. item_url: type: string format: uri description: The URL of the item in the project. required: - id - content_type - created_at - updated_at - archived_at projects-v2-single-select-options: title: Projects v2 Single Select Option description: An option for a single select field type: object properties: id: type: string description: The unique identifier of the option. name: type: object description: The display name of the option, in raw text and HTML formats. properties: raw: type: string html: type: string required: - raw - html description: type: object description: The description of the option, in raw text and HTML formats. properties: raw: type: string html: type: string required: - raw - html color: type: string description: The color associated with the option. required: - id - name - description - color projects-v2-iteration-settings: title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object properties: id: type: string description: The unique identifier of the iteration setting. start_date: type: string format: date description: The start date of the iteration. duration: type: integer description: The duration of the iteration in days. title: type: object properties: raw: type: string html: type: string required: - raw - html description: The iteration title, in raw text and HTML formats. completed: type: boolean description: Whether the iteration has been completed. required: - id - start_date - duration - title - completed projects-v2-field: title: Projects v2 Field description: A field inside a projects v2 project type: object properties: id: type: integer description: The unique identifier of the field. node_id: type: string description: The node ID of the field. project_url: type: string description: The API URL of the project that contains the field. example: https://api.github.com/projects/1 name: type: string description: The name of the field. data_type: type: string description: The field's data type. enum: - assignees - linked_pull_requests - reviewers - labels - milestone - repository - title - text - single_select - number - date - iteration - issue_type - parent_issue - sub_issues_progress options: type: array description: The options available for single select fields. items: "$ref": "#/components/schemas/projects-v2-single-select-options" configuration: type: object description: Configuration for iteration fields. properties: start_day: type: integer description: The day of the week when the iteration starts. duration: type: integer description: The duration of the iteration in days. iterations: type: array items: "$ref": "#/components/schemas/projects-v2-iteration-settings" created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the field was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the field was last updated. required: - id - name - data_type - created_at - updated_at - project_url projects-v2-item-with-content: title: Projects v2 Item description: An item belonging to a project type: object properties: id: type: number description: The unique identifier of the project item. node_id: type: string description: The node ID of the project item. project_url: type: string format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. content_type: "$ref": "#/components/schemas/projects-v2-item-content-type" content: type: object additionalProperties: true nullable: true description: The content of the item, which varies by content type. creator: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the item was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the item was last updated. archived_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true description: The time when the item was archived. item_url: type: string format: uri example: https://api.github.com/users/monalisa/2/projectsV2/items/3 nullable: true description: The API URL of this item. fields: type: array items: type: object additionalProperties: true description: The fields and values associated with this item. required: - id - content_type - created_at - updated_at - archived_at org-repo-custom-property-values: title: Organization Repository Custom Property Values description: List of custom property values for a repository type: object properties: repository_id: type: integer example: 1296269 repository_name: type: string example: Hello-World repository_full_name: type: string example: octocat/Hello-World properties: type: array items: "$ref": "#/components/schemas/custom-property-value" description: List of custom property names and associated values required: - repository_id - repository_name - repository_full_name - properties nullable-repository: title: Repository description: A repository on GitHub. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" forks: type: integer permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push owner: "$ref": "#/components/schemas/simple-user" private: description: Whether the repository is private or public. default: false type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true deprecated: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_update_branch: description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. default: false type: boolean example: false use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo type: boolean web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean open_issues: type: integer watchers: type: integer master_branch: type: string starred_at: type: string example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository code_search_index_status: type: object description: The status of the code search index for this repository properties: lexical_search_ok: type: boolean lexical_commit_sha: type: string required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at nullable: true code-of-conduct-simple: title: Code Of Conduct Simple description: Code of Conduct Simple type: object properties: url: type: string format: uri example: https://api.github.com/repos/github/docs/community/code_of_conduct key: type: string example: citizen_code_of_conduct name: type: string example: Citizen Code of Conduct html_url: type: string nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md required: - url - key - name - html_url full-repository: title: Full Repository description: Full Repository type: object properties: id: type: integer format: int64 example: 1296269 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: type: string example: Hello-World full_name: type: string example: octocat/Hello-World owner: "$ref": "#/components/schemas/simple-user" private: type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: type: string example: master open_issues_count: type: integer example: 0 is_template: type: boolean example: true topics: type: array items: type: string example: - octocat - atom - electron - API has_issues: type: boolean example: true has_projects: type: boolean example: true has_wiki: type: boolean example: true has_pages: type: boolean has_downloads: type: boolean example: true has_discussions: type: boolean example: true archived: type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' type: string example: public pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean required: - admin - pull - push allow_rebase_merge: type: boolean example: true template_repository: "$ref": "#/components/schemas/nullable-repository" temp_clone_token: type: string nullable: true allow_squash_merge: type: boolean example: true allow_auto_merge: type: boolean example: false delete_branch_on_merge: type: boolean example: false allow_merge_commit: type: boolean example: true allow_update_branch: type: boolean example: true use_squash_pr_title_as_default: type: boolean example: false squash_merge_commit_title: type: string example: PR_TITLE enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string example: PR_BODY enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string example: PR_TITLE enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string example: PR_BODY enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_forking: type: boolean example: true web_commit_signoff_required: type: boolean example: false subscribers_count: type: integer example: 42 network_count: type: integer example: 0 license: "$ref": "#/components/schemas/nullable-license-simple" organization: "$ref": "#/components/schemas/nullable-simple-user" parent: "$ref": "#/components/schemas/repository" source: "$ref": "#/components/schemas/repository" forks: type: integer master_branch: type: string open_issues: type: integer watchers: type: integer anonymous_access_enabled: description: Whether anonymous git access is allowed. default: true type: boolean code_of_conduct: "$ref": "#/components/schemas/code-of-conduct-simple" security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" custom_properties: type: object description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_issues - has_projects - has_wiki - has_pages - has_discussions - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at - network_count - subscribers_count org-rules: title: Repository Rule type: object description: A repository rule. oneOf: - "$ref": "#/components/schemas/repository-rule-creation" - "$ref": "#/components/schemas/repository-rule-update" - "$ref": "#/components/schemas/repository-rule-deletion" - "$ref": "#/components/schemas/repository-rule-required-linear-history" - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-required-signatures" - "$ref": "#/components/schemas/repository-rule-pull-request" - "$ref": "#/components/schemas/repository-rule-required-status-checks" - "$ref": "#/components/schemas/repository-rule-non-fast-forward" - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-code-scanning" rule-suites: title: Rule Suites description: Response type: array items: type: object properties: id: type: integer description: The unique identifier of the rule insight. actor_id: type: integer description: The number that identifies the user. actor_name: type: string description: The handle for the GitHub user account. before_sha: type: string description: The first commit sha before the push evaluation. after_sha: type: string description: The last commit sha in the push evaluation. ref: type: string description: The ref name that the evaluation ran on. repository_id: type: integer description: The ID of the repository associated with the rule evaluation. repository_name: type: string description: The name of the repository without the `.git` extension. pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' result: type: string enum: - pass - fail - bypass description: The result of the rule evaluations for rules with the `active` enforcement status. evaluation_result: type: string enum: - pass - fail - bypass description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. rule-suite: title: Rule Suite description: Response type: object properties: id: type: integer description: The unique identifier of the rule insight. actor_id: type: integer description: The number that identifies the user. nullable: true actor_name: type: string description: The handle for the GitHub user account. nullable: true before_sha: type: string description: The previous commit SHA of the ref. after_sha: type: string description: The new commit SHA of the ref. ref: type: string description: The ref name that the evaluation ran on. repository_id: type: integer description: The ID of the repository associated with the rule evaluation. repository_name: type: string description: The name of the repository without the `.git` extension. pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' result: type: string enum: - pass - fail - bypass description: The result of the rule evaluations for rules with the `active` enforcement status. evaluation_result: type: string nullable: true enum: - pass - fail - bypass description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. rule_evaluations: type: array description: Details on the evaluated rules. items: type: object properties: rule_source: type: object properties: type: type: string description: The type of rule source. id: type: integer nullable: true description: The ID of the rule source. name: type: string nullable: true description: The name of the rule source. enforcement: type: string enum: - active - evaluate - deleted ruleset description: The enforcement level of this rule source. result: type: string enum: - pass - fail description: The result of the evaluation of the individual rule. rule_type: type: string description: The type of rule. details: type: string nullable: true description: The detailed failure message for the rule. Null if the rule passed. repository-advisory-vulnerability: description: A product affected by the vulnerability detailed in a repository security advisory. type: object properties: package: description: The name of the package affected by the vulnerability. type: object nullable: true properties: ecosystem: "$ref": "#/components/schemas/security-advisory-ecosystems" name: type: string description: The unique package name within its ecosystem. nullable: true required: - ecosystem - name vulnerable_version_range: type: string description: The range of the package versions affected by the vulnerability. nullable: true patched_versions: type: string description: The package version(s) that resolve the vulnerability. nullable: true vulnerable_functions: type: array description: The functions in the package that are affected. nullable: true items: type: string required: - package - vulnerable_version_range - patched_versions - vulnerable_functions additionalProperties: false repository-advisory-credit: description: A credit given to a user for a repository security advisory. type: object properties: user: "$ref": "#/components/schemas/simple-user" type: "$ref": "#/components/schemas/security-advisory-credit-types" state: type: string description: The state of the user's acceptance of the credit. enum: - accepted - declined - pending required: - user - type - state additionalProperties: false repository-advisory: description: A repository security advisory. type: object properties: ghsa_id: type: string description: The GitHub Security Advisory ID. readOnly: true cve_id: type: string description: The Common Vulnerabilities and Exposures (CVE) ID. nullable: true url: type: string format: uri description: The API URL for the advisory. readOnly: true html_url: type: string format: uri description: The URL for the advisory. readOnly: true summary: type: string description: A short summary of the advisory. maxLength: 1024 description: type: string description: A detailed description of what the advisory entails. maxLength: 65535 nullable: true severity: type: string description: The severity of the advisory. nullable: true enum: - critical - high - medium - low author: readOnly: true nullable: true description: The author of the advisory. allOf: - "$ref": "#/components/schemas/simple-user" publisher: readOnly: true nullable: true description: The publisher of the advisory. allOf: - "$ref": "#/components/schemas/simple-user" identifiers: type: array items: type: object properties: type: type: string description: The type of identifier. enum: - CVE - GHSA value: type: string description: The identifier value. required: - type - value readOnly: true state: type: string description: The state of the advisory. enum: - published - closed - withdrawn - draft - triage created_at: type: string format: date-time description: The date and time of when the advisory was created, in ISO 8601 format. readOnly: true nullable: true updated_at: type: string format: date-time description: The date and time of when the advisory was last updated, in ISO 8601 format. readOnly: true nullable: true published_at: type: string format: date-time description: The date and time of when the advisory was published, in ISO 8601 format. readOnly: true nullable: true closed_at: type: string format: date-time description: The date and time of when the advisory was closed, in ISO 8601 format. readOnly: true nullable: true withdrawn_at: type: string format: date-time description: The date and time of when the advisory was withdrawn, in ISO 8601 format. readOnly: true nullable: true submission: type: object nullable: true readOnly: true properties: accepted: type: boolean description: Whether a private vulnerability report was accepted by the repository's administrators. readOnly: true required: - accepted vulnerabilities: type: array nullable: true items: "$ref": "#/components/schemas/repository-advisory-vulnerability" cvss: type: object nullable: true properties: vector_string: type: string description: The CVSS vector. nullable: true score: type: number description: The CVSS score. minimum: 0 maximum: 10 nullable: true readOnly: true required: - vector_string - score cvss_severities: "$ref": "#/components/schemas/cvss-severities" cwes: type: array nullable: true items: type: object properties: cwe_id: type: string description: The Common Weakness Enumeration (CWE) identifier. name: type: string description: The name of the CWE. readOnly: true required: - cwe_id - name readOnly: true cwe_ids: type: array description: A list of only the CWE IDs. nullable: true items: type: string credits: type: array nullable: true items: type: object properties: login: type: string description: The username of the user credited. type: "$ref": "#/components/schemas/security-advisory-credit-types" credits_detailed: type: array nullable: true items: "$ref": "#/components/schemas/repository-advisory-credit" readOnly: true collaborating_users: type: array description: A list of users that collaborate on the advisory. nullable: true items: "$ref": "#/components/schemas/simple-user" collaborating_teams: type: array description: A list of teams that collaborate on the advisory. nullable: true items: "$ref": "#/components/schemas/team" private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - "$ref": "#/components/schemas/simple-repository" required: - ghsa_id - cve_id - url - html_url - summary - description - severity - author - publisher - identifiers - state - created_at - updated_at - published_at - closed_at - withdrawn_at - submission - vulnerabilities - cvss - cwes - cwe_ids - credits - credits_detailed - collaborating_users - collaborating_teams - private_fork additionalProperties: false immutable-releases-organization-settings: title: Check immutable releases organization settings description: Check immutable releases settings for an organization. type: object properties: enforced_repositories: type: string description: The policy that controls how immutable releases are enforced in the organization. enum: - all - none - selected example: all selected_repositories_url: type: string description: The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. required: - enforced_repositories group-mapping: title: GroupMapping description: External Groups to be mapped to a team for membership type: object properties: groups: description: Array of groups to be mapped to this team example: - group_id: 111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa group_name: saml-azuread-test group_description: A group of Developers working on AzureAD SAML SSO - group_id: 2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2 group_name: saml-azuread-test2 group_description: Another group of Developers working on AzureAD SAML SSO type: array items: type: object required: - group_id - group_name - group_description properties: group_id: description: The ID of the group example: 111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa type: string group_name: description: The name of the group example: saml-azuread-test type: string group_description: description: a description of the group example: A group of Developers working on AzureAD SAML SSO type: string status: description: synchronization status for this group mapping example: unsynced type: string synced_at: description: the time of the last sync for this group-mapping example: 2019-06-03 22:27:15:000 -700 type: string nullable: true team-organization: title: Team Organization description: Team Organization type: object properties: login: type: string example: github id: type: integer example: 1 node_id: type: string example: MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri example: https://api.github.com/orgs/github repos_url: type: string format: uri example: https://api.github.com/orgs/github/repos events_url: type: string format: uri example: https://api.github.com/orgs/github/events hooks_url: type: string example: https://api.github.com/orgs/github/hooks issues_url: type: string example: https://api.github.com/orgs/github/issues members_url: type: string example: https://api.github.com/orgs/github/members{/member} public_members_url: type: string example: https://api.github.com/orgs/github/public_members{/member} avatar_url: type: string example: https://github.com/images/error/octocat_happy.gif description: type: string example: A great organization nullable: true name: type: string example: github company: type: string example: GitHub blog: type: string format: uri example: https://github.com/blog location: type: string example: San Francisco email: type: string format: email example: octocat@github.com twitter_username: type: string example: github nullable: true is_verified: type: boolean example: true has_organization_projects: type: boolean example: true has_repository_projects: type: boolean example: true public_repos: type: integer example: 2 public_gists: type: integer example: 1 followers: type: integer example: 20 following: type: integer example: 0 html_url: type: string format: uri example: https://github.com/octocat created_at: type: string format: date-time example: '2008-01-14T04:33:35Z' type: type: string example: Organization total_private_repos: type: integer example: 100 owned_private_repos: type: integer example: 100 private_gists: type: integer example: 81 nullable: true disk_usage: type: integer example: 10000 nullable: true collaborators: type: integer example: 8 nullable: true billing_email: type: string format: email example: org@example.com nullable: true plan: type: object properties: name: type: string space: type: integer private_repos: type: integer filled_seats: type: integer seats: type: integer required: - name - space - private_repos default_repository_permission: type: string nullable: true members_can_create_repositories: type: boolean example: true nullable: true two_factor_requirement_enabled: type: boolean example: true nullable: true members_allowed_repository_creation_type: type: string example: all members_can_create_public_repositories: type: boolean example: true members_can_create_private_repositories: type: boolean example: true members_can_create_internal_repositories: type: boolean example: true members_can_create_pages: type: boolean example: true members_can_create_public_pages: type: boolean example: true members_can_create_private_pages: type: boolean example: true members_can_fork_private_repositories: type: boolean example: false nullable: true web_commit_signoff_required: type: boolean example: false updated_at: type: string format: date-time archived_at: type: string format: date-time nullable: true required: - login - url - id - node_id - repos_url - events_url - hooks_url - issues_url - members_url - public_members_url - avatar_url - description - html_url - has_organization_projects - has_repository_projects - public_repos - public_gists - followers - following - type - created_at - updated_at - archived_at ldap-dn: type: string description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. example: cn=Enterprise Ops,ou=teams,dc=github,dc=com team-full: title: Full Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: description: Unique identifier of the team example: 42 type: integer node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team example: https://api.github.com/organizations/1/team/1 type: string format: uri html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core name: description: Name of the team example: Developers type: string slug: type: string example: justice-league description: type: string example: A great team. nullable: true privacy: description: The level of privacy this team should have type: string enum: - closed - secret example: closed notification_setting: description: The notification setting the team has set type: string enum: - notifications_enabled - notifications_disabled example: notifications_enabled permission: description: Permission that the team will have for its repositories example: push type: string members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos parent: "$ref": "#/components/schemas/nullable-team-simple" members_count: type: integer example: 3 repos_count: type: integer example: 10 created_at: type: string format: date-time example: '2017-07-14T16:53:42Z' updated_at: type: string format: date-time example: '2017-08-17T12:37:15Z' organization: "$ref": "#/components/schemas/team-organization" ldap_dn: "$ref": "#/components/schemas/ldap-dn" type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - type - created_at - updated_at - members_count - repos_count - organization team-discussion: title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. type: object properties: author: "$ref": "#/components/schemas/nullable-simple-user" body: description: The main text of the discussion. example: Please suggest improvements to our workflow in comments. type: string body_html: type: string example: "

Hi! This is an area for us to collaborate as a team

" body_version: description: The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. example: 0307116bbf7ced493b8d8a346c650b71 type: string comments_count: type: integer example: 0 comments_url: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments created_at: type: string format: date-time example: '2018-01-25T18:56:31Z' last_edited_at: type: string format: date-time nullable: true html_url: type: string format: uri example: https://github.com/orgs/github/teams/justice-league/discussions/1 node_id: type: string example: MDE0OlRlYW1EaXNjdXNzaW9uMQ== number: description: The unique sequence number of a team discussion. example: 42 type: integer pinned: description: Whether or not this discussion should be pinned for easy retrieval. example: true type: boolean private: description: Whether or not this discussion should be restricted to team members and organization owners. example: true type: boolean team_url: type: string format: uri example: https://api.github.com/organizations/1/team/2343027 title: description: The title of the discussion. example: How can we improve our workflow? type: string updated_at: type: string format: date-time example: '2018-01-25T18:56:31Z' url: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 reactions: "$ref": "#/components/schemas/reaction-rollup" required: - author - body - body_html - body_version - comments_count - comments_url - created_at - last_edited_at - html_url - pinned - private - node_id - number - team_url - title - updated_at - url team-discussion-comment: title: Team Discussion Comment description: A reply to a discussion within a team. type: object properties: author: "$ref": "#/components/schemas/nullable-simple-user" body: description: The main text of the comment. example: I agree with this suggestion. type: string body_html: type: string example: "

Do you like apples?

" body_version: description: The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. example: 0307116bbf7ced493b8d8a346c650b71 type: string created_at: type: string format: date-time example: '2018-01-15T23:53:58Z' last_edited_at: type: string format: date-time nullable: true discussion_url: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1 html_url: type: string format: uri example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 node_id: type: string example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= number: description: The unique sequence number of a team discussion comment. example: 42 type: integer updated_at: type: string format: date-time example: '2018-01-15T23:53:58Z' url: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 reactions: "$ref": "#/components/schemas/reaction-rollup" required: - author - body - body_html - body_version - created_at - last_edited_at - discussion_url - html_url - node_id - number - updated_at - url reaction: title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. type: object properties: id: type: integer example: 1 node_id: type: string example: MDg6UmVhY3Rpb24x user: "$ref": "#/components/schemas/nullable-simple-user" content: description: The reaction to use example: heart type: string enum: - "+1" - "-1" - laugh - confused - heart - hooray - rocket - eyes created_at: type: string format: date-time example: '2016-05-20T20:09:31Z' required: - id - node_id - user - content - created_at team-membership: title: Team Membership description: Team Membership type: object properties: url: type: string format: uri role: description: The role of the user in the team. enum: - member - maintainer default: member example: member type: string state: description: The state of the user's membership in the team. type: string enum: - active - pending required: - role - state - url team-project: title: Team Project description: A team's access to a project. type: object properties: owner_url: type: string url: type: string html_url: type: string columns_url: type: string id: type: integer node_id: type: string name: type: string body: type: string nullable: true number: type: integer state: type: string creator: "$ref": "#/components/schemas/simple-user" created_at: type: string updated_at: type: string organization_permission: description: The organization permission for this project. Only present when owner is an organization. type: string private: description: Whether the project is private or not. Only present when owner is an organization. type: boolean permissions: type: object properties: read: type: boolean write: type: boolean admin: type: boolean required: - read - write - admin required: - owner_url - url - html_url - columns_url - id - node_id - name - body - number - state - creator - created_at - updated_at - permissions team-repository: title: Team Repository description: A team's access to a repository. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" forks: type: integer permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push role_name: type: string example: admin owner: "$ref": "#/components/schemas/nullable-simple-user" private: description: Whether the repository is private or public. default: false type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo default: false type: boolean example: false web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean example: false subscribers_count: type: integer network_count: type: integer open_issues: type: integer watchers: type: integer master_branch: type: string required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at project-card: title: Project Card description: Project cards represent a scope of work. type: object properties: url: type: string format: uri example: https://api.github.com/projects/columns/cards/1478 id: description: The project card's ID example: 42 type: integer format: int64 node_id: type: string example: MDExOlByb2plY3RDYXJkMTQ3OA== note: type: string example: Add payload for delete Project column nullable: true creator: "$ref": "#/components/schemas/nullable-simple-user" created_at: type: string format: date-time example: '2016-09-05T14:21:06Z' updated_at: type: string format: date-time example: '2016-09-05T14:20:22Z' archived: description: Whether or not the card is archived example: false type: boolean column_name: type: string project_id: type: string column_url: type: string format: uri example: https://api.github.com/projects/columns/367 content_url: type: string format: uri example: https://api.github.com/repos/api-playground/projects-test/issues/3 project_url: type: string format: uri example: https://api.github.com/projects/120 required: - id - node_id - note - url - column_url - project_url - creator - created_at - updated_at project-column: title: Project Column description: Project columns contain cards of work. type: object properties: url: type: string format: uri example: https://api.github.com/projects/columns/367 project_url: type: string format: uri example: https://api.github.com/projects/120 cards_url: type: string format: uri example: https://api.github.com/projects/columns/367/cards id: description: The unique identifier of the project column example: 42 type: integer node_id: type: string example: MDEzOlByb2plY3RDb2x1bW4zNjc= name: description: Name of the project column example: Remaining tasks type: string created_at: type: string format: date-time example: '2016-09-05T14:18:44Z' updated_at: type: string format: date-time example: '2016-09-05T14:22:28Z' required: - id - node_id - url - project_url - cards_url - name - created_at - updated_at project-collaborator-permission: title: Project Collaborator Permission description: Project Collaborator Permission type: object properties: permission: type: string user: "$ref": "#/components/schemas/nullable-simple-user" required: - permission - user rate-limit: title: Rate Limit type: object properties: limit: type: integer remaining: type: integer reset: type: integer used: type: integer required: - limit - remaining - reset - used rate-limit-overview: title: Rate Limit Overview description: Rate Limit Overview type: object properties: resources: type: object properties: core: "$ref": "#/components/schemas/rate-limit" graphql: "$ref": "#/components/schemas/rate-limit" search: "$ref": "#/components/schemas/rate-limit" code_search: "$ref": "#/components/schemas/rate-limit" source_import: "$ref": "#/components/schemas/rate-limit" integration_manifest: "$ref": "#/components/schemas/rate-limit" code_scanning_upload: "$ref": "#/components/schemas/rate-limit" actions_runner_registration: "$ref": "#/components/schemas/rate-limit" scim: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" dependency_sbom: "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: - core - search rate: "$ref": "#/components/schemas/rate-limit" required: - rate - resources artifact: title: Artifact description: An artifact type: object properties: id: type: integer example: 5 node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 name: description: The name of the artifact. type: string example: AdventureWorks.Framework size_in_bytes: description: The size in bytes of the artifact. type: integer example: 12345 url: type: string example: https://api.github.com/repos/github/hello-world/actions/artifacts/5 archive_download_url: type: string example: https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip expired: description: Whether or not the artifact has expired. type: boolean created_at: type: string format: date-time nullable: true expires_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true digest: type: string description: The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. nullable: true example: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: type: object nullable: true properties: id: example: 10 type: integer repository_id: example: 42 type: integer head_repository_id: example: 42 type: integer head_branch: example: main type: string head_sha: example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' type: string required: - id - node_id - name - size_in_bytes - url - archive_download_url - expired - created_at - expires_at - updated_at actions-cache-list: title: Repository actions caches description: Repository actions caches type: object properties: total_count: description: Total number of caches type: integer example: 2 actions_caches: description: Array of caches type: array items: type: object properties: id: type: integer example: 2 ref: type: string example: refs/heads/main key: type: string example: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b version: type: string example: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 last_accessed_at: type: string format: date-time example: '2019-01-24T22:45:36.000Z' created_at: type: string format: date-time example: '2019-01-24T22:45:36.000Z' size_in_bytes: type: integer example: 1024 required: - total_count - actions_caches job: title: Job description: Information of a job execution in a workflow run type: object properties: id: description: The id of the job. example: 21 type: integer run_id: description: The id of the associated workflow run. example: 5 type: integer run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 run_attempt: type: integer description: Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. example: 1 node_id: type: string example: MDg6Q2hlY2tSdW40 head_sha: description: The SHA of the commit that is being run. example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' type: string url: type: string example: https://api.github.com/repos/github/hello-world/actions/jobs/21 html_url: type: string example: https://github.com/github/hello-world/runs/4 nullable: true status: description: The phase of the lifecycle that the job is currently in. example: queued type: string enum: - queued - in_progress - completed - waiting - requested - pending conclusion: description: The outcome of the job. example: success type: string nullable: true enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required created_at: description: The time that the job created, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string started_at: description: The time that the job started, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string completed_at: description: The time that the job finished, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string nullable: true name: description: The name of the job. example: test-coverage type: string steps: description: Steps in this job. type: array items: type: object required: - name - status - conclusion - number properties: status: description: The phase of the lifecycle that the job is currently in. example: queued type: string enum: - queued - in_progress - completed conclusion: description: The outcome of the job. example: success type: string nullable: true name: description: The name of the job. example: test-coverage type: string number: type: integer example: 1 started_at: description: The time that the step started, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string nullable: true completed_at: description: The time that the job finished, in ISO 8601 format. example: '2019-08-08T08:00:00-07:00' format: date-time type: string nullable: true check_run_url: type: string example: https://api.github.com/repos/github/hello-world/check-runs/4 labels: type: array items: type: string description: Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. example: - self-hosted - foo - bar runner_id: type: integer nullable: true example: 1 description: The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_name: type: string nullable: true example: my runner description: The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_group_id: type: integer nullable: true example: 2 description: The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) runner_group_name: type: string nullable: true example: my runner group description: The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) workflow_name: type: string description: The name of the workflow. nullable: true example: Build head_branch: type: string description: The name of the current branch. nullable: true example: main required: - id - node_id - run_id - run_url - head_sha - workflow_name - head_branch - name - url - html_url - status - conclusion - started_at - completed_at - check_run_url - labels - runner_id - runner_name - runner_group_id - runner_group_name - created_at oidc-custom-sub-repo: title: Actions OIDC subject customization for a repository description: Actions OIDC subject customization for a repository type: object properties: use_default: description: Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. type: boolean include_claim_keys: description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. type: array items: type: string required: - use_default actions-secret: title: Actions Secret description: Set secrets for GitHub Actions. type: object properties: name: description: The name of the secret. example: SECRET_TOKEN type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - name - created_at - updated_at actions-variable: title: Actions Variable type: object properties: name: description: The name of the variable. example: USERNAME type: string value: description: The value of the variable. example: octocat type: string created_at: description: The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time example: '2019-01-24T22:45:36.000Z' updated_at: description: The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time example: '2019-01-24T22:45:36.000Z' required: - name - value - created_at - updated_at actions-enabled: type: boolean description: Whether GitHub Actions is enabled on the repository. actions-repository-permissions: type: object properties: enabled: "$ref": "#/components/schemas/actions-enabled" allowed_actions: "$ref": "#/components/schemas/allowed-actions" selected_actions_url: "$ref": "#/components/schemas/selected-actions-url" sha_pinning_required: "$ref": "#/components/schemas/sha-pinning-required" required: - enabled actions-workflow-access-to-repository: type: object properties: access_level: type: string description: |- Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. enum: - none - user - organization - enterprise required: - access_level referenced-workflow: title: Referenced workflow description: A workflow referenced/reused by the initial caller workflow type: object properties: path: type: string sha: type: string ref: type: string required: - path - sha pull-request-minimal: title: Pull Request Minimal type: object properties: id: type: integer format: int64 number: type: integer url: type: string head: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer format: int64 url: type: string name: type: string required: - id - url - name required: - ref - sha - repo base: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer format: int64 url: type: string name: type: string required: - id - url - name required: - ref - sha - repo required: - id - number - url - head - base nullable-simple-commit: title: Simple Commit description: A commit. type: object properties: id: type: string description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd tree_id: type: string description: SHA for the commit's tree message: description: Message describing the purpose of the commit example: 'Fix #42' type: string timestamp: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string author: type: object description: Information about the Git author properties: name: description: Name of the commit's author example: Monalisa Octocat type: string email: description: Git email address of the commit's author example: monalisa.octocat@example.com type: string format: email required: - name - email nullable: true committer: type: object description: Information about the Git committer properties: name: description: Name of the commit's committer example: Monalisa Octocat type: string email: description: Git email address of the commit's committer example: monalisa.octocat@example.com type: string format: email required: - name - email nullable: true required: - id - tree_id - message - timestamp - author - committer nullable: true workflow-run: title: Workflow Run description: An invocation of a workflow type: object properties: id: type: integer description: The ID of the workflow run. example: 5 name: type: string description: The name of the workflow run. nullable: true example: Build node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer description: The ID of the associated check suite. example: 42 check_suite_node_id: type: string description: The node ID of the associated check suite. example: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: type: string nullable: true example: master head_sha: description: The SHA of the head commit that points to the version of the workflow being run. example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' type: string path: description: The full path of the workflow example: octocat/octo-repo/.github/workflows/ci.yml@main type: string run_number: type: integer description: The auto incrementing run number for the workflow run. example: 106 run_attempt: type: integer description: Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. example: 1 referenced_workflows: type: array nullable: true items: "$ref": "#/components/schemas/referenced-workflow" event: type: string example: push status: type: string nullable: true example: completed conclusion: type: string nullable: true example: neutral workflow_id: type: integer description: The ID of the parent workflow. example: 5 url: type: string description: The URL to the workflow run. example: https://api.github.com/repos/github/hello-world/actions/runs/5 html_url: type: string example: https://github.com/github/hello-world/suites/4 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. type: array nullable: true items: "$ref": "#/components/schemas/pull-request-minimal" created_at: type: string format: date-time updated_at: type: string format: date-time actor: "$ref": "#/components/schemas/simple-user" triggering_actor: "$ref": "#/components/schemas/simple-user" run_started_at: type: string format: date-time description: The start time of the latest run. Resets on re-run. jobs_url: description: The URL to the jobs for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs logs_url: description: The URL to download the logs for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs check_suite_url: description: The URL to the associated check suite. type: string example: https://api.github.com/repos/github/hello-world/check-suites/12 artifacts_url: description: The URL to the artifacts for the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts cancel_url: description: The URL to cancel the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel rerun_url: description: The URL to rerun the workflow run. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun previous_attempt_url: nullable: true description: The URL to the previous attempted run of this workflow, if one exists. type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 workflow_url: description: The URL to the workflow. type: string example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml head_commit: "$ref": "#/components/schemas/nullable-simple-commit" repository: "$ref": "#/components/schemas/minimal-repository" head_repository: "$ref": "#/components/schemas/minimal-repository" head_repository_id: type: integer example: 5 display_title: type: string example: Simple Workflow description: The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. required: - id - node_id - head_branch - run_number - display_title - event - status - conclusion - head_sha - path - workflow_id - url - html_url - created_at - updated_at - head_commit - head_repository - repository - jobs_url - logs_url - check_suite_url - cancel_url - rerun_url - artifacts_url - workflow_url - pull_requests environment-approvals: title: Environment Approval description: An entry in the reviews log for environment deployments type: object properties: environments: description: The list of environments that were approved or rejected type: array items: type: object properties: id: description: The id of the environment. example: 56780428 type: integer node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= name: description: The name of the environment. example: staging type: string url: type: string example: https://api.github.com/repos/github/hello-world/environments/staging html_url: type: string example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging created_at: description: The time that the environment was created, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string updated_at: description: The time that the environment was last updated, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string state: description: Whether deployment to the environment(s) was approved or rejected or pending (with comments) enum: - approved - rejected - pending example: approved type: string user: "$ref": "#/components/schemas/simple-user" comment: type: string description: The comment submitted with the deployment review example: Ship it! required: - environments - state - user - comment review-custom-gates-comment-required: type: object properties: environment_name: type: string description: The name of the environment to approve or reject. comment: type: string description: Comment associated with the pending deployment protection rule. **Required when state is not provided.** required: - environment_name - comment review-custom-gates-state-required: type: object properties: environment_name: type: string description: The name of the environment to approve or reject. state: type: string description: Whether to approve or reject deployment to the specified environments. enum: - approved - rejected comment: type: string description: Optional comment to include with the review. required: - environment_name - state deployment-reviewer-type: type: string description: The type of reviewer. enum: - User - Team example: User pending-deployment: title: Pending Deployment description: Details of a deployment that is waiting for protection rules to pass type: object properties: environment: type: object properties: id: description: The id of the environment. type: integer format: int64 example: 56780428 node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= name: description: The name of the environment. example: staging type: string url: type: string example: https://api.github.com/repos/github/hello-world/environments/staging html_url: type: string example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging wait_timer: type: integer description: The set duration of the wait timer example: 30 wait_timer_started_at: description: The time that the wait timer began. example: '2020-11-23T22:00:40Z' format: date-time type: string nullable: true current_user_can_approve: description: Whether the currently authenticated user can approve the deployment type: boolean example: true reviewers: type: array description: The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. items: type: object properties: type: "$ref": "#/components/schemas/deployment-reviewer-type" reviewer: anyOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/team" required: - environment - wait_timer - wait_timer_started_at - current_user_can_approve - reviewers deployment: title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment type: integer format: int64 example: 42 node_id: type: string example: MDEwOkRlcGxveW1lbnQx sha: type: string example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d ref: description: The ref to deploy. This can be a branch, tag, or sha. example: topic-branch type: string task: description: Parameter to specify a task to execute example: deploy type: string payload: oneOf: - type: object additionalProperties: true - type: string original_environment: type: string example: staging environment: description: Name for the target deployment environment. example: production type: string description: type: string example: Deploy request from hubot nullable: true creator: "$ref": "#/components/schemas/nullable-simple-user" created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example transient_environment: description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.' example: true type: boolean production_environment: description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.' example: true type: boolean performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" required: - id - node_id - sha - ref - task - environment - creator - payload - description - statuses_url - repository_url - url - created_at - updated_at workflow-run-usage: title: Workflow Run Usage description: Workflow Run Usage type: object properties: billable: type: object properties: UBUNTU: type: object required: - total_ms - jobs properties: total_ms: type: integer jobs: type: integer job_runs: type: array items: type: object required: - job_id - duration_ms properties: job_id: type: integer duration_ms: type: integer MACOS: type: object required: - total_ms - jobs properties: total_ms: type: integer jobs: type: integer job_runs: type: array items: type: object required: - job_id - duration_ms properties: job_id: type: integer duration_ms: type: integer WINDOWS: type: object required: - total_ms - jobs properties: total_ms: type: integer jobs: type: integer job_runs: type: array items: type: object required: - job_id - duration_ms properties: job_id: type: integer duration_ms: type: integer run_duration_ms: type: integer required: - billable workflow: title: Workflow description: A GitHub Actions workflow type: object properties: id: type: integer example: 5 node_id: type: string example: MDg6V29ya2Zsb3cxMg== name: type: string example: CI path: type: string example: ruby.yaml state: type: string example: active enum: - active - deleted - disabled_fork - disabled_inactivity - disabled_manually created_at: type: string format: date-time example: '2019-12-06T14:20:20.000Z' updated_at: type: string format: date-time example: '2019-12-06T14:20:20.000Z' url: type: string example: https://api.github.com/repos/actions/setup-ruby/workflows/5 html_url: type: string example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml badge_url: type: string example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg deleted_at: type: string format: date-time example: '2019-12-06T14:20:20.000Z' required: - id - node_id - name - path - state - url - html_url - badge_url - created_at - updated_at workflow-usage: title: Workflow Usage description: Workflow Usage type: object properties: billable: type: object properties: UBUNTU: type: object properties: total_ms: type: integer MACOS: type: object properties: total_ms: type: integer WINDOWS: type: object properties: total_ms: type: integer required: - billable activity: title: Activity description: Activity type: object properties: id: type: integer example: 1296269 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 before: type: string example: 6dcb09b5b57875f334f61aebed695e2e4193db5e description: The SHA of the commit before the activity. after: type: string example: 827efc6d56897b048c772eb4087f854f46256132 description: The SHA of the commit after the activity. ref: type: string example: refs/heads/main description: The full Git reference, formatted as `refs/heads/`. timestamp: type: string format: date-time example: '2011-01-26T19:06:43Z' description: The time when the activity occurred. activity_type: type: string example: force_push enum: - push - force_push - branch_deletion - branch_creation - pr_merge - merge_queue_merge description: The type of the activity that was performed. actor: "$ref": "#/components/schemas/nullable-simple-user" required: - id - node_id - before - after - ref - timestamp - activity_type - actor autolink: title: Autolink reference description: An autolink reference. type: object properties: id: type: integer example: 3 key_prefix: description: The prefix of a key that is linkified. example: TICKET- type: string url_template: description: A template for the target URL that is generated if a key was found. example: https://example.com/TICKET?query= type: string is_alphanumeric: description: Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. example: true type: boolean updated_at: type: string nullable: true format: date-time required: - id - key_prefix - url_template - is_alphanumeric check-automated-security-fixes: title: Check Dependabot security updates description: Check Dependabot security updates type: object properties: enabled: type: boolean example: true description: Whether Dependabot security updates are enabled for the repository. paused: type: boolean example: false description: Whether Dependabot security updates are paused for the repository. required: - enabled - paused protected-branch-required-status-check: title: Protected Branch Required Status Check description: Protected Branch Required Status Check type: object properties: url: type: string enforcement_level: type: string contexts: type: array items: type: string checks: type: array items: type: object properties: context: type: string app_id: type: integer nullable: true required: - context - app_id contexts_url: type: string strict: type: boolean required: - contexts - checks protected-branch-admin-enforced: title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: type: boolean example: true required: - url - enabled protected-branch-pull-request-review: title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions dismissal_restrictions: type: object properties: users: description: The list of users with review dismissal access. type: array items: "$ref": "#/components/schemas/simple-user" teams: description: The list of teams with review dismissal access. type: array items: "$ref": "#/components/schemas/team" apps: description: The list of apps with review dismissal access. type: array items: "$ref": "#/components/schemas/integration" url: type: string example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions"' users_url: type: string example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users"' teams_url: type: string example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams"' bypass_pull_request_allowances: type: object description: Allow specific users, teams, or apps to bypass pull request requirements. properties: users: description: The list of users allowed to bypass pull request requirements. type: array items: "$ref": "#/components/schemas/simple-user" teams: description: The list of teams allowed to bypass pull request requirements. type: array items: "$ref": "#/components/schemas/team" apps: description: The list of apps allowed to bypass pull request requirements. type: array items: "$ref": "#/components/schemas/integration" dismiss_stale_reviews: type: boolean example: true require_code_owner_reviews: type: boolean example: true required_approving_review_count: type: integer minimum: 0 maximum: 6 example: 2 require_last_push_approval: description: Whether the most recent push must be approved by someone other than the person who pushed it. type: boolean example: true default: false required: - dismiss_stale_reviews - require_code_owner_reviews branch-restriction-policy: title: Branch Restriction Policy description: Branch Restriction Policy type: object properties: url: type: string format: uri users_url: type: string format: uri teams_url: type: string format: uri apps_url: type: string format: uri users: type: array items: type: object properties: login: type: string id: type: integer format: int64 node_id: type: string avatar_url: type: string gravatar_id: type: string url: type: string html_url: type: string followers_url: type: string following_url: type: string gists_url: type: string starred_url: type: string subscriptions_url: type: string organizations_url: type: string repos_url: type: string events_url: type: string received_events_url: type: string type: type: string site_admin: type: boolean user_view_type: type: string teams: type: array items: "$ref": "#/components/schemas/team" apps: type: array items: type: object properties: id: type: integer slug: type: string node_id: type: string owner: type: object properties: login: type: string id: type: integer node_id: type: string url: type: string repos_url: type: string events_url: type: string hooks_url: type: string issues_url: type: string members_url: type: string public_members_url: type: string avatar_url: type: string description: type: string gravatar_id: type: string example: '""' html_url: type: string example: '"https://github.com/testorg-ea8ec76d71c3af4b"' followers_url: type: string example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"' following_url: type: string example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"' gists_url: type: string example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"' starred_url: type: string example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"' subscriptions_url: type: string example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"' organizations_url: type: string example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"' received_events_url: type: string example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"' type: type: string example: '"Organization"' site_admin: type: boolean example: false user_view_type: type: string example: public name: type: string client_id: type: string description: type: string external_url: type: string html_url: type: string created_at: type: string updated_at: type: string permissions: type: object properties: metadata: type: string contents: type: string issues: type: string single_file: type: string events: type: array items: type: string required: - url - users_url - teams_url - apps_url - users - teams - apps branch-protection: title: Branch Protection description: Branch Protection type: object properties: url: type: string enabled: type: boolean required_status_checks: "$ref": "#/components/schemas/protected-branch-required-status-check" enforce_admins: "$ref": "#/components/schemas/protected-branch-admin-enforced" required_pull_request_reviews: "$ref": "#/components/schemas/protected-branch-pull-request-review" restrictions: "$ref": "#/components/schemas/branch-restriction-policy" required_linear_history: type: object properties: enabled: type: boolean allow_force_pushes: type: object properties: enabled: type: boolean allow_deletions: type: object properties: enabled: type: boolean block_creations: type: object properties: enabled: type: boolean required_conversation_resolution: type: object properties: enabled: type: boolean name: type: string example: '"branch/with/protection"' protection_url: type: string example: '"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection"' required_signatures: type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: type: boolean example: true required: - url - enabled lock_branch: type: object description: Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. properties: enabled: default: false type: boolean allow_fork_syncing: type: object description: Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. properties: enabled: default: false type: boolean short-branch: title: Short Branch description: Short Branch type: object properties: name: type: string commit: type: object properties: sha: type: string url: type: string format: uri required: - sha - url protected: type: boolean protection: "$ref": "#/components/schemas/branch-protection" protection_url: type: string format: uri required: - name - commit - protected nullable-git-user: title: Git User description: Metaproperties for Git author/committer information. type: object properties: name: type: string example: '"Chris Wanstrath"' email: type: string example: '"chris@ozmm.org"' date: type: string example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: title: Verification type: object properties: verified: type: boolean reason: type: string payload: type: string nullable: true signature: type: string nullable: true verified_at: type: string nullable: true required: - verified - reason - payload - signature - verified_at diff-entry: title: Diff Entry description: Diff Entry type: object properties: sha: type: string nullable: true example: bbcd538c8e72b8c175046e27cc8f907076331401 filename: type: string example: file1.txt status: type: string enum: - added - removed - modified - renamed - copied - changed - unchanged example: added additions: type: integer example: 103 deletions: type: integer example: 21 changes: type: integer example: 124 blob_url: type: string format: uri example: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt raw_url: type: string format: uri example: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt contents_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e patch: type: string example: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" previous_filename: type: string example: file.txt required: - additions - blob_url - changes - contents_url - deletions - filename - raw_url - sha - status commit: title: Commit description: Commit type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: type: string example: 6dcb09b5b57875f334f61aebed695e2e4193db5e node_id: type: string example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== html_url: type: string format: uri example: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments commit: type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e author: "$ref": "#/components/schemas/nullable-git-user" committer: "$ref": "#/components/schemas/nullable-git-user" message: type: string example: Fix all the bugs comment_count: type: integer example: 0 tree: type: object properties: sha: type: string example: 827efc6d56897b048c772eb4087f854f46256132 url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 required: - sha - url verification: "$ref": "#/components/schemas/verification" required: - author - committer - comment_count - message - tree - url author: nullable: true oneOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/empty-object" committer: nullable: true oneOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/empty-object" parents: type: array items: type: object properties: sha: type: string example: 7638417db6d59f3c431d3e1f261cc637155684cd url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd html_url: type: string format: uri example: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd required: - sha - url stats: type: object properties: additions: type: integer deletions: type: integer total: type: integer files: type: array items: "$ref": "#/components/schemas/diff-entry" required: - url - sha - node_id - html_url - comments_url - commit - author - committer - parents branch-with-protection: title: Branch With Protection description: Branch With Protection type: object properties: name: type: string commit: "$ref": "#/components/schemas/commit" _links: type: object properties: html: type: string self: type: string format: uri required: - html - self protected: type: boolean protection: "$ref": "#/components/schemas/branch-protection" protection_url: type: string format: uri pattern: type: string example: '"mas*"' required_approving_review_count: type: integer example: 1 required: - name - commit - _links - protection - protected - protection_url status-check-policy: title: Status Check Policy description: Status Check Policy type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: type: boolean example: true contexts: type: array example: - continuous-integration/travis-ci items: type: string checks: type: array items: type: object properties: context: type: string example: continuous-integration/travis-ci app_id: type: integer nullable: true required: - context - app_id contexts_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts required: - url - contexts_url - strict - contexts - checks protected-branch: title: Protected Branch description: Branch protections protect branches type: object properties: url: type: string format: uri required_status_checks: "$ref": "#/components/schemas/status-check-policy" required_pull_request_reviews: type: object properties: url: type: string format: uri dismiss_stale_reviews: type: boolean require_code_owner_reviews: type: boolean required_approving_review_count: type: integer require_last_push_approval: description: Whether the most recent push must be approved by someone other than the person who pushed it. type: boolean default: false dismissal_restrictions: type: object properties: url: type: string format: uri users_url: type: string format: uri teams_url: type: string format: uri users: type: array items: "$ref": "#/components/schemas/simple-user" teams: type: array items: "$ref": "#/components/schemas/team" apps: type: array items: "$ref": "#/components/schemas/integration" required: - url - users_url - teams_url - users - teams bypass_pull_request_allowances: type: object properties: users: type: array items: "$ref": "#/components/schemas/simple-user" teams: type: array items: "$ref": "#/components/schemas/team" apps: type: array items: "$ref": "#/components/schemas/integration" required: - users - teams required: - url required_signatures: type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: type: boolean example: true required: - url - enabled enforce_admins: type: object properties: url: type: string format: uri enabled: type: boolean additionalProperties: false required: - url - enabled required_linear_history: type: object properties: enabled: type: boolean additionalProperties: false required: - enabled allow_force_pushes: type: object properties: enabled: type: boolean additionalProperties: false required: - enabled allow_deletions: type: object properties: enabled: type: boolean additionalProperties: false required: - enabled restrictions: "$ref": "#/components/schemas/branch-restriction-policy" required_conversation_resolution: type: object properties: enabled: type: boolean additionalProperties: false block_creations: type: object properties: enabled: type: boolean additionalProperties: false required: - enabled lock_branch: type: object description: Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. properties: enabled: default: false type: boolean additionalProperties: false allow_fork_syncing: type: object description: Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. properties: enabled: default: false type: boolean additionalProperties: false required: - url deployment-simple: title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment example: 42 type: integer node_id: type: string example: MDEwOkRlcGxveW1lbnQx task: description: Parameter to specify a task to execute example: deploy type: string original_environment: type: string example: staging environment: description: Name for the target deployment environment. example: production type: string description: type: string example: Deploy request from hubot nullable: true created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example transient_environment: description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.' example: true type: boolean production_environment: description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.' example: true type: boolean performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" required: - id - node_id - task - environment - description - statuses_url - repository_url - url - created_at - updated_at check-run: title: CheckRun description: A check performed on the code of a given code change type: object properties: id: description: The id of the check. example: 21 type: integer format: int64 head_sha: description: The SHA of the commit that is being checked. example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' type: string node_id: type: string example: MDg6Q2hlY2tSdW40 external_id: type: string example: '42' nullable: true url: type: string example: https://api.github.com/repos/github/hello-world/check-runs/4 html_url: type: string example: https://github.com/github/hello-world/runs/4 nullable: true details_url: type: string example: https://example.com nullable: true status: description: The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. example: queued type: string enum: - queued - in_progress - completed - waiting - requested - pending conclusion: type: string example: neutral enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required nullable: true started_at: type: string format: date-time example: '2018-05-04T01:14:52Z' nullable: true completed_at: type: string format: date-time example: '2018-05-04T01:14:52Z' nullable: true output: type: object properties: title: type: string nullable: true summary: type: string nullable: true text: type: string nullable: true annotations_count: type: integer annotations_url: type: string format: uri required: - title - summary - text - annotations_count - annotations_url name: description: The name of the check. example: test-coverage type: string check_suite: type: object properties: id: type: integer required: - id nullable: true app: "$ref": "#/components/schemas/nullable-integration" pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array items: "$ref": "#/components/schemas/pull-request-minimal" deployment: "$ref": "#/components/schemas/deployment-simple" required: - id - node_id - head_sha - name - url - html_url - details_url - status - conclusion - started_at - completed_at - external_id - check_suite - output - app - pull_requests check-annotation: title: Check Annotation description: Check Annotation type: object properties: path: type: string example: README.md start_line: type: integer example: 2 end_line: type: integer example: 2 start_column: type: integer example: 5 nullable: true end_column: type: integer example: 10 nullable: true annotation_level: type: string example: warning nullable: true title: type: string example: Spell Checker nullable: true message: type: string example: Check your spelling for 'banaas'. nullable: true raw_details: type: string example: Do you mean 'bananas' or 'banana'? nullable: true blob_href: type: string required: - path - blob_href - start_line - end_line - start_column - end_column - annotation_level - title - message - raw_details simple-commit: title: Simple Commit description: A commit. type: object properties: id: type: string description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd tree_id: type: string description: SHA for the commit's tree message: description: Message describing the purpose of the commit example: 'Fix #42' type: string timestamp: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string author: type: object description: Information about the Git author properties: name: description: Name of the commit's author example: Monalisa Octocat type: string email: description: Git email address of the commit's author example: monalisa.octocat@example.com type: string format: email required: - name - email nullable: true committer: type: object description: Information about the Git committer properties: name: description: Name of the commit's committer example: Monalisa Octocat type: string email: description: Git email address of the commit's committer example: monalisa.octocat@example.com type: string format: email required: - name - email nullable: true required: - id - tree_id - message - timestamp - author - committer check-suite: title: CheckSuite description: A suite of checks performed on the code of a given code change type: object properties: id: type: integer example: 5 format: int64 node_id: type: string example: MDEwOkNoZWNrU3VpdGU1 head_branch: type: string example: master nullable: true head_sha: description: The SHA of the head commit that is being checked. example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' type: string status: type: string description: The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. example: completed enum: - queued - in_progress - completed - waiting - requested - pending nullable: true conclusion: type: string example: neutral enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required - startup_failure - stale - null nullable: true url: type: string example: https://api.github.com/repos/github/hello-world/check-suites/5 nullable: true before: type: string example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 nullable: true after: type: string example: d6fde92930d4715a2b49857d24b940956b26d2d3 nullable: true pull_requests: type: array items: "$ref": "#/components/schemas/pull-request-minimal" nullable: true app: "$ref": "#/components/schemas/nullable-integration" repository: "$ref": "#/components/schemas/minimal-repository" created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true head_commit: "$ref": "#/components/schemas/simple-commit" latest_check_runs_count: type: integer check_runs_url: type: string rerequestable: type: boolean runs_rerequestable: type: boolean required: - id - node_id - head_branch - status - conclusion - head_sha - url - before - after - created_at - updated_at - app - head_commit - repository - latest_check_runs_count - check_runs_url - pull_requests check-suite-preference: title: Check Suite Preference description: Check suite configuration preferences for a repository. type: object required: - preferences - repository properties: preferences: type: object properties: auto_trigger_checks: type: array items: type: object properties: app_id: type: integer setting: type: boolean required: - app_id - setting repository: "$ref": "#/components/schemas/minimal-repository" code-scanning-alert-items: type: object properties: number: "$ref": "#/components/schemas/alert-number" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/alert-updated-at" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" instances_url: "$ref": "#/components/schemas/alert-instances-url" state: "$ref": "#/components/schemas/code-scanning-alert-state" fixed_at: "$ref": "#/components/schemas/alert-fixed-at" dismissed_by: "$ref": "#/components/schemas/nullable-simple-user" dismissed_at: "$ref": "#/components/schemas/alert-dismissed-at" dismissed_reason: "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" rule: "$ref": "#/components/schemas/code-scanning-alert-rule-summary" tool: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: "$ref": "#/components/schemas/code-scanning-alert-instance" dismissal_approved_by: "$ref": "#/components/schemas/nullable-simple-user" assignees: type: array items: "$ref": "#/components/schemas/simple-user" required: - number - created_at - url - html_url - instances_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool - most_recent_instance code-scanning-alert-rule: type: object properties: id: nullable: true type: string description: A unique identifier for the rule used to detect the alert. name: type: string description: The name of the rule used to detect the alert. severity: nullable: true type: string description: The severity of the alert. enum: - none - note - warning - error security_severity_level: nullable: true type: string description: The security severity of the alert. enum: - low - medium - high - critical description: type: string description: A short description of the rule used to detect the alert. full_description: type: string description: A description of the rule used to detect the alert. tags: nullable: true type: array description: A set of tags applicable for the rule. items: type: string help: nullable: true type: string description: Detailed documentation for the rule as GitHub Flavored Markdown. help_uri: nullable: true type: string description: A link to the documentation for the rule used to detect the alert. code-scanning-alert: type: object properties: number: "$ref": "#/components/schemas/alert-number" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/alert-updated-at" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" instances_url: "$ref": "#/components/schemas/alert-instances-url" state: "$ref": "#/components/schemas/code-scanning-alert-state" fixed_at: "$ref": "#/components/schemas/alert-fixed-at" dismissed_by: "$ref": "#/components/schemas/nullable-simple-user" dismissed_at: "$ref": "#/components/schemas/alert-dismissed-at" dismissed_reason: "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" rule: "$ref": "#/components/schemas/code-scanning-alert-rule" tool: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: "$ref": "#/components/schemas/code-scanning-alert-instance" dismissal_approved_by: "$ref": "#/components/schemas/nullable-simple-user" assignees: type: array items: "$ref": "#/components/schemas/simple-user" required: - number - created_at - url - html_url - instances_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool - most_recent_instance code-scanning-alert-set-state: description: Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. type: string enum: - open - dismissed code-scanning-alert-create-request: type: boolean description: If `true`, attempt to create an alert dismissal request. code-scanning-autofix-status: type: string description: The status of an autofix. enum: - pending - error - success - outdated code-scanning-autofix-description: type: string description: The description of an autofix. nullable: true code-scanning-autofix-started-at: type: string description: 'The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true code-scanning-autofix: type: object properties: status: "$ref": "#/components/schemas/code-scanning-autofix-status" description: "$ref": "#/components/schemas/code-scanning-autofix-description" started_at: "$ref": "#/components/schemas/code-scanning-autofix-started-at" required: - status - description - started_at code-scanning-autofix-commits: description: Commit an autofix for a code scanning alert type: object properties: target_ref: description: The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. type: string message: description: Commit message to be used. type: string nullable: true code-scanning-autofix-commits-response: type: object properties: target_ref: type: string description: The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. sha: type: string description: SHA of commit with autofix. code-scanning-analysis-sarif-id: type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 code-scanning-analysis-commit-sha: description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" code-scanning-analysis-environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. code-scanning-analysis-created-at: type: string description: 'The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true code-scanning-analysis-url: type: string description: The REST API URL of the analysis resource. format: uri readOnly: true code-scanning-analysis: type: object properties: ref: "$ref": "#/components/schemas/code-scanning-ref" commit_sha: "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" analysis_key: "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" environment: "$ref": "#/components/schemas/code-scanning-analysis-environment" category: "$ref": "#/components/schemas/code-scanning-analysis-category" error: type: string example: error reading field xyz created_at: "$ref": "#/components/schemas/code-scanning-analysis-created-at" results_count: type: integer description: The total number of results in the analysis. rules_count: type: integer description: The total number of rules used in the analysis. id: type: integer description: Unique identifier for this analysis. url: "$ref": "#/components/schemas/code-scanning-analysis-url" sarif_id: "$ref": "#/components/schemas/code-scanning-analysis-sarif-id" tool: "$ref": "#/components/schemas/code-scanning-analysis-tool" deletable: type: boolean warning: type: string description: Warning generated when processing the analysis example: 123 results were ignored required: - ref - commit_sha - analysis_key - environment - error - created_at - results_count - rules_count - id - url - sarif_id - tool - deletable - warning code-scanning-analysis-deletion: title: Analysis deletion description: Successful deletion of a code scanning analysis type: object properties: next_analysis_url: type: string description: Next deletable analysis in chain, without last analysis deletion confirmation format: uri readOnly: true nullable: true confirm_delete_url: type: string description: Next deletable analysis in chain, with last analysis deletion confirmation format: uri readOnly: true nullable: true required: - next_analysis_url - confirm_delete_url code-scanning-codeql-database: title: CodeQL Database description: A CodeQL database. type: object properties: id: type: integer description: The ID of the CodeQL database. name: type: string description: The name of the CodeQL database. language: type: string description: The language of the CodeQL database. uploader: "$ref": "#/components/schemas/simple-user" content_type: type: string description: The MIME type of the CodeQL database file. size: type: integer description: The size of the CodeQL database file in bytes. created_at: type: string format: date-time description: The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. updated_at: type: string format: date-time description: The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. url: type: string format: uri description: The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. commit_oid: type: string description: The commit SHA of the repository at the time the CodeQL database was created. nullable: true required: - id - name - language - uploader - content_type - size - created_at - updated_at - url code-scanning-variant-analysis-language: type: string description: The language targeted by the CodeQL query enum: - actions - cpp - csharp - go - java - javascript - python - ruby - rust - swift code-scanning-variant-analysis-repository: title: Repository Identifier description: Repository Identifier type: object properties: id: type: integer example: 1296269 description: A unique identifier of the repository. name: type: string example: Hello-World description: The name of the repository. full_name: type: string example: octocat/Hello-World description: The full, globally unique, name of the repository. private: type: boolean description: Whether the repository is private. stargazers_count: type: integer example: 80 updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true required: - full_name - id - name - private - stargazers_count - updated_at code-scanning-variant-analysis-status: type: string description: The new status of the CodeQL variant analysis repository task. enum: - pending - in_progress - succeeded - failed - canceled - timed_out code-scanning-variant-analysis-skipped-repo-group: type: object properties: repository_count: type: integer description: The total number of repositories that were skipped for this reason. example: 2 repositories: type: array description: A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. items: "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" required: - repository_count - repositories code-scanning-variant-analysis: title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object properties: id: type: integer description: The ID of the variant analysis. controller_repo: "$ref": "#/components/schemas/simple-repository" actor: "$ref": "#/components/schemas/simple-user" query_language: "$ref": "#/components/schemas/code-scanning-variant-analysis-language" query_pack_url: type: string description: The download url for the query pack. created_at: type: string format: date-time description: The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. updated_at: type: string format: date-time description: The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. completed_at: type: string format: date-time nullable: true description: The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. status: type: string enum: - in_progress - succeeded - failed - cancelled actions_workflow_run_id: type: integer description: The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. failure_reason: type: string enum: - no_repos_queried - actions_workflow_run_failed - internal_error description: The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. scanned_repositories: type: array items: type: object properties: repository: "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" analysis_status: "$ref": "#/components/schemas/code-scanning-variant-analysis-status" result_count: type: integer description: The number of results in the case of a successful analysis. This is only available for successful analyses. artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available for successful analyses. failure_message: type: string description: The reason of the failure of this repo task. This is only available if the repository task has failed. required: - repository - analysis_status skipped_repositories: type: object description: Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. properties: access_mismatch_repos: "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" not_found_repos: type: object properties: repository_count: type: integer description: The total number of repositories that were skipped for this reason. example: 2 repository_full_names: type: array description: A list of full repository names that were skipped. This list may not include all repositories that were skipped. items: type: string required: - repository_count - repository_full_names no_codeql_db_repos: "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" over_limit_repos: "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" required: - access_mismatch_repos - not_found_repos - no_codeql_db_repos - over_limit_repos required: - id - controller_repo - actor - query_language - query_pack_url - status code-scanning-variant-analysis-repo-task: type: object properties: repository: "$ref": "#/components/schemas/simple-repository" analysis_status: "$ref": "#/components/schemas/code-scanning-variant-analysis-status" artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available for successful analyses. result_count: type: integer description: The number of results in the case of a successful analysis. This is only available for successful analyses. failure_message: type: string description: The reason of the failure of this repo task. This is only available if the repository task has failed. database_commit_sha: type: string description: The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. source_location_prefix: type: string description: The source location prefix to use. This is only available for successful analyses. artifact_url: type: string description: The URL of the artifact. This is only available for successful analyses. required: - repository - analysis_status code-scanning-default-setup: description: Configuration for code scanning default setup. type: object properties: state: description: Code scanning default setup has been configured or not. type: string enum: - configured - not-configured languages: description: Languages to be analyzed. type: array items: type: string enum: - actions - c-cpp - csharp - go - java-kotlin - javascript-typescript - javascript - python - ruby - typescript - swift runner_type: description: Runner type to be used. nullable: true type: string enum: - standard - labeled runner_label: description: Runner label to be used if the runner type is labeled. nullable: true type: string example: code-scanning query_suite: description: CodeQL query suite to be used. type: string enum: - default - extended threat_model: description: Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. type: string enum: - remote - remote_and_local updated_at: description: Timestamp of latest configuration update. nullable: true type: string format: date-time example: '2023-12-06T14:20:20.000Z' schedule: description: The frequency of the periodic analysis. nullable: true type: string enum: - weekly code-scanning-default-setup-update: description: Configuration for code scanning default setup. type: object properties: state: description: The desired state of code scanning default setup. type: string enum: - configured - not-configured runner_type: description: Runner type to be used. type: string enum: - standard - labeled runner_label: nullable: true description: Runner label to be used if the runner type is labeled. type: string example: code-scanning query_suite: description: CodeQL query suite to be used. type: string enum: - default - extended threat_model: description: Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. type: string enum: - remote - remote_and_local languages: description: CodeQL languages to be analyzed. type: array items: type: string enum: - actions - c-cpp - csharp - go - java-kotlin - javascript-typescript - python - ruby - swift additionalProperties: false code-scanning-default-setup-update-response: description: |- You can use `run_url` to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow run object. type: object properties: run_id: description: ID of the corresponding run. type: integer run_url: description: URL of the corresponding run. type: string code-scanning-ref-full: type: string description: |- The full Git reference, formatted as `refs/heads/`, `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. pattern: "^refs/(heads|tags|pull)/.*$" example: refs/heads/main code-scanning-analysis-sarif-file: description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secure-coding/sarif-support-for-code-scanning)." type: string code-scanning-sarifs-receipt: type: object properties: id: "$ref": "#/components/schemas/code-scanning-analysis-sarif-id" url: type: string description: The REST API URL for checking the status of the upload. format: uri readOnly: true code-scanning-sarifs-status: type: object properties: processing_status: type: string enum: - pending - complete - failed description: "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed." analyses_url: type: string description: The REST API URL for getting the analyses associated with the upload. format: uri readOnly: true nullable: true errors: type: array items: type: string description: Any errors that ocurred during processing of the delivery. readOnly: true nullable: true code-security-configuration-for-repository: type: object description: Code security configuration associated with a repository and attachment status properties: status: type: string description: The attachment status of the code security configuration on the repository. enum: - attached - attaching - detached - removed - enforced - failed - updating - removed_by_enterprise configuration: "$ref": "#/components/schemas/code-security-configuration" codeowners-errors: title: CODEOWNERS errors description: A list of errors found in a repo's CODEOWNERS file type: object properties: errors: type: array items: type: object properties: line: description: The line number where this errors occurs. type: integer example: 7 column: description: The column number where this errors occurs. type: integer example: 3 source: description: The contents of the line where the error occurs. type: string example: "* user" kind: description: The type of error. type: string example: Invalid owner suggestion: description: Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. type: string nullable: true example: The pattern `/` will never match anything, did you mean `*` instead? message: description: A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). type: string example: |- Invalid owner on line 7: * user ^ path: description: The path of the file where the error occured. type: string example: ".github/CODEOWNERS" required: - line - column - kind - message - path required: - errors codespace-machine: type: object title: Codespace machine description: A description of the machine powering a codespace. properties: name: type: string description: The name of the machine. example: standardLinux display_name: type: string description: The display name of the machine includes cores, memory, and storage. example: 4 cores, 16 GB RAM, 64 GB storage operating_system: type: string description: The operating system of the machine. example: linux storage_in_bytes: type: integer description: How much storage is available to the codespace. example: 68719476736 memory_in_bytes: type: integer description: How much memory is available to the codespace. example: 17179869184 cpus: type: integer description: How many cores are available to the codespace. example: 4 prebuild_availability: type: string description: Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. example: ready enum: - none - ready - in_progress nullable: true required: - name - display_name - operating_system - storage_in_bytes - memory_in_bytes - cpus - prebuild_availability codespaces-permissions-check-for-devcontainer: title: Codespaces Permissions Check description: Permission check result for a given devcontainer config. type: object properties: accepted: description: Whether the user has accepted the permissions defined by the devcontainer config example: true type: boolean required: - accepted repo-codespaces-secret: title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object properties: name: description: The name of the secret. example: SECRET_TOKEN type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - name - created_at - updated_at collaborator: title: Collaborator description: Collaborator type: object properties: login: type: string example: octocat id: type: integer format: int64 example: 1 email: nullable: true type: string name: nullable: true type: string node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - push - admin role_name: type: string example: admin user_view_type: type: string example: public required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url - role_name repository-invitation: title: Repository Invitation description: Repository invitations let you manage who you collaborate with. type: object properties: id: description: Unique identifier of the repository invitation. example: 42 type: integer format: int64 repository: "$ref": "#/components/schemas/minimal-repository" invitee: "$ref": "#/components/schemas/nullable-simple-user" inviter: "$ref": "#/components/schemas/nullable-simple-user" permissions: description: The permission associated with the invitation. example: read type: string enum: - read - write - admin - triage - maintain created_at: type: string format: date-time example: '2016-06-13T14:52:50-05:00' expired: description: Whether or not the invitation has expired type: boolean url: description: URL for the repository invitation example: https://api.github.com/user/repository-invitations/1 type: string html_url: type: string example: https://github.com/octocat/Hello-World/invitations node_id: type: string required: - id - node_id - permissions - inviter - invitee - repository - url - html_url - created_at nullable-collaborator: title: Collaborator description: Collaborator type: object properties: login: type: string example: octocat id: type: integer format: int64 example: 1 email: nullable: true type: string name: nullable: true type: string node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - push - admin role_name: type: string example: admin user_view_type: type: string example: public required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url - role_name nullable: true repository-collaborator-permission: title: Repository Collaborator Permission description: Repository Collaborator Permission type: object properties: permission: type: string role_name: type: string example: admin user: "$ref": "#/components/schemas/nullable-collaborator" required: - permission - role_name - user commit-comment: title: Commit Comment description: Commit Comment type: object properties: html_url: type: string format: uri url: type: string format: uri id: type: integer node_id: type: string body: type: string path: type: string nullable: true position: type: integer nullable: true line: type: integer nullable: true commit_id: type: string user: "$ref": "#/components/schemas/nullable-simple-user" created_at: type: string format: date-time updated_at: type: string format: date-time author_association: "$ref": "#/components/schemas/author-association" reactions: "$ref": "#/components/schemas/reaction-rollup" required: - url - html_url - id - node_id - user - position - line - path - commit_id - body - author_association - created_at - updated_at branch-short: title: Branch Short description: Branch Short type: object properties: name: type: string commit: type: object properties: sha: type: string url: type: string required: - sha - url protected: type: boolean required: - name - commit - protected simple-commit-status: title: Simple Commit Status type: object properties: description: type: string nullable: true id: type: integer node_id: type: string state: type: string context: type: string target_url: type: string format: uri nullable: true required: type: boolean nullable: true avatar_url: type: string nullable: true format: uri url: type: string format: uri created_at: type: string format: date-time updated_at: type: string format: date-time required: - description - id - node_id - state - context - target_url - avatar_url - url - created_at - updated_at combined-commit-status: title: Combined Commit Status description: Combined Commit Status type: object properties: state: type: string statuses: type: array items: "$ref": "#/components/schemas/simple-commit-status" sha: type: string total_count: type: integer repository: "$ref": "#/components/schemas/minimal-repository" commit_url: type: string format: uri url: type: string format: uri required: - state - sha - total_count - statuses - repository - commit_url - url status: title: Status description: The status of a commit. type: object properties: url: type: string avatar_url: type: string nullable: true id: type: integer node_id: type: string state: type: string description: type: string nullable: true target_url: type: string nullable: true context: type: string created_at: type: string updated_at: type: string creator: "$ref": "#/components/schemas/nullable-simple-user" required: - url - avatar_url - id - node_id - state - description - target_url - context - created_at - updated_at - creator nullable-code-of-conduct-simple: title: Code Of Conduct Simple description: Code of Conduct Simple type: object properties: url: type: string format: uri example: https://api.github.com/repos/github/docs/community/code_of_conduct key: type: string example: citizen_code_of_conduct name: type: string example: Citizen Code of Conduct html_url: type: string nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md required: - url - key - name - html_url nullable: true nullable-community-health-file: title: Community Health File type: object properties: url: type: string format: uri html_url: type: string format: uri required: - url - html_url nullable: true community-profile: title: Community Profile description: Community Profile type: object properties: health_percentage: type: integer example: 100 description: type: string example: My first repository on GitHub! nullable: true documentation: type: string example: example.com nullable: true files: type: object properties: code_of_conduct: "$ref": "#/components/schemas/nullable-code-of-conduct-simple" code_of_conduct_file: "$ref": "#/components/schemas/nullable-community-health-file" license: "$ref": "#/components/schemas/nullable-license-simple" contributing: "$ref": "#/components/schemas/nullable-community-health-file" readme: "$ref": "#/components/schemas/nullable-community-health-file" issue_template: "$ref": "#/components/schemas/nullable-community-health-file" pull_request_template: "$ref": "#/components/schemas/nullable-community-health-file" required: - code_of_conduct - code_of_conduct_file - license - contributing - readme - issue_template - pull_request_template updated_at: type: string format: date-time example: '2017-02-28T19:09:29Z' nullable: true content_reports_enabled: type: boolean example: true required: - health_percentage - description - documentation - files - updated_at commit-comparison: title: Commit Comparison description: Commit Comparison type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/compare/master...topic html_url: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic permalink_url: type: string format: uri example: https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 diff_url: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.diff patch_url: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch base_commit: "$ref": "#/components/schemas/commit" merge_base_commit: "$ref": "#/components/schemas/commit" status: type: string enum: - diverged - ahead - behind - identical example: ahead ahead_by: type: integer example: 4 behind_by: type: integer example: 5 total_commits: type: integer example: 6 commits: type: array items: "$ref": "#/components/schemas/commit" files: type: array items: "$ref": "#/components/schemas/diff-entry" required: - url - html_url - permalink_url - diff_url - patch_url - base_commit - merge_base_commit - status - ahead_by - behind_by - total_commits - commits content-tree: title: Content Tree description: Content Tree type: object properties: type: type: string size: type: integer name: type: string path: type: string sha: type: string content: type: string url: type: string format: uri git_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true entries: type: array items: type: object properties: type: type: string size: type: integer name: type: string path: type: string sha: type: string url: type: string format: uri git_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url encoding: type: string _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url content-directory: title: Content Directory description: A list of directory items type: array items: type: object properties: type: type: string enum: - dir - file - submodule - symlink size: type: integer name: type: string path: type: string content: type: string sha: type: string url: type: string format: uri git_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url content-file: title: Content File description: Content File type: object properties: type: type: string enum: - file encoding: type: string size: type: integer name: type: string path: type: string content: type: string sha: type: string url: type: string format: uri git_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self target: type: string example: '"actual/actual.md"' submodule_git_url: type: string example: '"git://example.com/defunkt/dotjs.git"' required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url - content - encoding content-symlink: title: Symlink Content description: An object describing a symlink type: object properties: type: type: string enum: - symlink target: type: string size: type: integer name: type: string path: type: string sha: type: string url: type: string format: uri git_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url - target content-submodule: title: Submodule Content description: An object describing a submodule type: object properties: type: type: string enum: - submodule submodule_git_url: type: string format: uri size: type: integer name: type: string path: type: string sha: type: string url: type: string format: uri git_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url - submodule_git_url file-commit: title: File Commit description: File Commit type: object required: - content - commit properties: content: type: object properties: name: type: string path: type: string sha: type: string size: type: integer url: type: string html_url: type: string git_url: type: string download_url: type: string type: type: string _links: type: object properties: self: type: string git: type: string html: type: string nullable: true commit: type: object properties: sha: type: string node_id: type: string url: type: string html_url: type: string author: type: object properties: date: type: string name: type: string email: type: string committer: type: object properties: date: type: string name: type: string email: type: string message: type: string tree: type: object properties: url: type: string sha: type: string parents: type: array items: type: object properties: url: type: string html_url: type: string sha: type: string verification: type: object properties: verified: type: boolean reason: type: string signature: type: string nullable: true payload: type: string nullable: true verified_at: type: string nullable: true secret-scanning-push-protection-bypass-placeholder-id: description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. type: string repository-rule-violation-error: description: Repository rule violation was detected type: object properties: message: type: string documentation_url: type: string status: type: string metadata: type: object properties: secret_scanning: type: object properties: bypass_placeholders: type: array items: type: object properties: placeholder_id: "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" token_type: type: string contributor: title: Contributor description: Contributor type: object properties: login: type: string id: type: integer node_id: type: string avatar_url: type: string format: uri gravatar_id: type: string nullable: true url: type: string format: uri html_url: type: string format: uri followers_url: type: string format: uri following_url: type: string gists_url: type: string starred_url: type: string subscriptions_url: type: string format: uri organizations_url: type: string format: uri repos_url: type: string format: uri events_url: type: string received_events_url: type: string format: uri type: type: string site_admin: type: boolean contributions: type: integer email: type: string name: type: string user_view_type: type: string required: - contributions - type dependabot-alert: type: object description: A Dependabot alert. properties: number: "$ref": "#/components/schemas/alert-number" state: type: string description: The state of the Dependabot alert. readOnly: true enum: - auto_dismissed - dismissed - fixed - open dependency: type: object description: Details for the vulnerable dependency. readOnly: true properties: package: "$ref": "#/components/schemas/dependabot-alert-package" manifest_path: type: string description: The full path to the dependency manifest file, relative to the root of the repository. readOnly: true scope: type: string description: The execution scope of the vulnerable dependency. readOnly: true nullable: true enum: - development - runtime relationship: type: string description: | The vulnerable dependency's relationship to your project. > [!NOTE] > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. readOnly: true nullable: true enum: - unknown - direct - transitive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/alert-updated-at" dismissed_at: "$ref": "#/components/schemas/alert-dismissed-at" dismissed_by: "$ref": "#/components/schemas/nullable-simple-user" dismissed_reason: type: string description: The reason that the alert was dismissed. nullable: true enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk dismissed_comment: type: string description: An optional comment associated with the alert's dismissal. nullable: true maxLength: 280 fixed_at: "$ref": "#/components/schemas/alert-fixed-at" auto_dismissed_at: "$ref": "#/components/schemas/alert-auto-dismissed-at" required: - number - state - dependency - security_advisory - security_vulnerability - url - html_url - created_at - updated_at - dismissed_at - dismissed_by - dismissed_reason - dismissed_comment - fixed_at additionalProperties: false dependabot-secret: title: Dependabot Secret description: Set secrets for Dependabot. type: object properties: name: description: The name of the secret. example: MY_ARTIFACTORY_PASSWORD type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - name - created_at - updated_at dependency-graph-diff: title: Dependency Graph Diff description: A diff of the dependencies between two commits. type: array items: type: object properties: change_type: type: string enum: - added - removed manifest: type: string example: path/to/package-lock.json ecosystem: type: string example: npm name: type: string example: "@actions/core" version: type: string example: 1.0.0 package_url: type: string nullable: true example: pkg:/npm/%40actions/core@1.1.0 license: type: string nullable: true example: MIT source_repository_url: type: string nullable: true example: https://github.com/github/actions vulnerabilities: type: array items: type: object properties: severity: type: string example: critical advisory_ghsa_id: type: string example: GHSA-rf4j-j272-fj86 advisory_summary: type: string example: A summary of the advisory. advisory_url: type: string example: https://github.com/advisories/GHSA-rf4j-j272-fj86 required: - severity - advisory_ghsa_id - advisory_summary - advisory_url scope: description: Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment. type: string enum: - unknown - runtime - development required: - change_type - manifest - ecosystem - name - version - package_url - license - source_repository_url - vulnerabilities - scope dependency-graph-spdx-sbom: title: Dependency Graph SPDX SBOM description: A schema for the SPDX JSON format returned by the Dependency Graph. type: object properties: sbom: type: object properties: SPDXID: type: string example: SPDXRef-DOCUMENT description: The SPDX identifier for the SPDX document. spdxVersion: type: string example: SPDX-2.3 description: The version of the SPDX specification that this document conforms to. comment: type: string example: 'Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' description: An optional comment about the SPDX document. creationInfo: type: object properties: created: type: string example: '2021-11-03T00:00:00Z' description: The date and time the SPDX document was created. creators: type: array items: type: string example: GitHub description: The tools that were used to generate the SPDX document. required: - created - creators name: type: string example: github/github description: The name of the SPDX document. dataLicense: type: string example: CC0-1.0 description: The license under which the SPDX document is licensed. documentNamespace: type: string example: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 description: The namespace for the SPDX document. packages: type: array items: type: object properties: SPDXID: type: string example: SPDXRef-Package description: A unique SPDX identifier for the package. name: type: string example: github/github description: The name of the package. versionInfo: type: string example: 1.0.0 description: |- The version of the package. If the package does not have an exact version specified, a version range is given. downloadLocation: type: string example: NOASSERTION description: |- The location where the package can be downloaded, or NOASSERTION if this has not been determined. filesAnalyzed: type: boolean example: false description: |- Whether the package's file content has been subjected to analysis during the creation of the SPDX document. licenseConcluded: type: string example: MIT description: The license of the package as determined while creating the SPDX document. licenseDeclared: type: string example: NOASSERTION description: |- The license of the package as declared by its author, or NOASSERTION if this information was not available when the SPDX document was created. supplier: type: string example: NOASSERTION description: The distribution source of this package, or NOASSERTION if this was not determined. copyrightText: type: string example: Copyright (c) 1985 GitHub.com description: The copyright holders of the package, and any dates present with those notices, if available. externalRefs: type: array items: type: object properties: referenceCategory: type: string example: PACKAGE-MANAGER description: The category of reference to an external resource this reference refers to. referenceLocator: type: string example: pkg:gem/rails@6.0.1 description: A locator for the particular external resource this reference refers to. referenceType: type: string example: purl description: The category of reference to an external resource this reference refers to. required: - referenceCategory - referenceLocator - referenceType required: - SPDXID - name - versionInfo - downloadLocation - filesAnalyzed relationships: type: array items: type: object properties: relationshipType: type: string example: DEPENDS_ON description: The type of relationship between the two SPDX elements. spdxElementId: type: string description: The SPDX identifier of the package that is the source of the relationship. relatedSpdxElement: type: string description: The SPDX identifier of the package that is the target of the relationship. required: - relationshipType - spdxElementId - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - documentNamespace - packages required: - sbom metadata: title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. type: object maxProperties: 8 additionalProperties: nullable: true anyOf: - type: string - type: number - type: boolean dependency: type: object properties: package_url: type: string description: Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" metadata: "$ref": "#/components/schemas/metadata" relationship: type: string description: A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. example: direct enum: - direct - indirect scope: type: string description: A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. example: runtime enum: - runtime - development dependencies: type: array description: Array of package-url (PURLs) of direct child dependencies. example: "@actions/http-client" items: type: string additionalProperties: false manifest: type: object properties: name: type: string description: The name of the manifest. example: package-lock.json file: type: object properties: source_location: type: string description: The path of the manifest file relative to the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false metadata: "$ref": "#/components/schemas/metadata" resolved: type: object description: A collection of resolved package dependencies. additionalProperties: "$ref": "#/components/schemas/dependency" required: - name additionalProperties: false snapshot: title: snapshot description: Create a new snapshot of a repository's dependencies. type: object properties: version: description: The version of the repository snapshot submission. type: integer job: type: object properties: id: type: string description: The external ID of the job. example: 5622a2b0-63f6-4732-8c34-a1ab27e102a11 correlator: type: string description: Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation. example: yourworkflowname_yourjobname html_url: type: string description: The url for the job. example: http://example.com/build required: - id - correlator additionalProperties: false sha: description: 'The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.' type: string example: ddc951f4b1293222421f2c8df679786153acf689 minLength: 40 maxLength: 40 ref: description: The repository branch that triggered this snapshot. type: string pattern: "^refs/" example: refs/heads/main detector: type: object description: A description of the detector used. properties: name: type: string description: The name of the detector used. example: docker buildtime detector version: type: string description: The version of the detector used. example: 1.0.0 url: type: string description: The url of the detector used. example: http://example.com/docker-buildtimer-detector required: - name - version - url additionalProperties: false metadata: "$ref": "#/components/schemas/metadata" manifests: type: object description: A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. additionalProperties: "$ref": "#/components/schemas/manifest" scanned: type: string format: date-time description: The time at which the snapshot was scanned. example: '2020-06-13T14:52:50-05:00' required: - detector - version - ref - sha - job - scanned additionalProperties: false deployment-status: title: Deployment Status description: The status of a deployment. type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: type: integer format: int64 example: 1 node_id: type: string example: MDE2OkRlcGxveW1lbnRTdGF0dXMx state: description: The state of the status. enum: - error - failure - inactive - pending - success - queued - in_progress example: success type: string creator: "$ref": "#/components/schemas/nullable-simple-user" description: description: A short description of the status. default: '' type: string maxLength: 140 example: Deployment finished successfully. environment: description: The environment of the deployment that the status is for. default: '' type: string example: production target_url: description: 'Closing down notice: the URL to associate with this status.' default: '' type: string format: uri example: https://example.com/deployment/42/output created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' deployment_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/42 repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example environment_url: description: The URL for accessing your environment. default: '' type: string format: uri example: https://staging.example.com/ log_url: description: The URL to associate with this status. default: '' type: string format: uri example: https://example.com/deployment/42/output performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" required: - id - node_id - state - creator - description - deployment_url - target_url - repository_url - url - created_at - updated_at wait-timer: type: integer example: 30 description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). deployment-branch-policy-settings: type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. properties: protected_branches: type: boolean description: Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. custom_branch_policies: type: boolean description: Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. nullable: true required: - protected_branches - custom_branch_policies environment: title: Environment description: Details of a deployment environment type: object properties: id: description: The id of the environment. example: 56780428 type: integer format: int64 node_id: type: string example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= name: description: The name of the environment. example: staging type: string url: type: string example: https://api.github.com/repos/github/hello-world/environments/staging html_url: type: string example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging created_at: description: The time that the environment was created, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string updated_at: description: The time that the environment was last updated, in ISO 8601 format. example: '2020-11-23T22:00:40Z' format: date-time type: string protection_rules: type: array description: Built-in deployment protection rules for the environment. items: anyOf: - type: object properties: id: type: integer example: 3515 node_id: type: string example: MDQ6R2F0ZTM1MTU= type: type: string example: wait_timer wait_timer: "$ref": "#/components/schemas/wait-timer" required: - id - node_id - type - type: object properties: id: type: integer example: 3755 node_id: type: string example: MDQ6R2F0ZTM3NTU= prevent_self_review: type: boolean example: false description: Whether deployments to this environment can be approved by the user who created the deployment. type: type: string example: required_reviewers reviewers: type: array description: The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. items: type: object properties: type: "$ref": "#/components/schemas/deployment-reviewer-type" reviewer: anyOf: - "$ref": "#/components/schemas/simple-user" - "$ref": "#/components/schemas/team" required: - id - node_id - type - type: object properties: id: type: integer example: 3515 node_id: type: string example: MDQ6R2F0ZTM1MTU= type: type: string example: branch_policy required: - id - node_id - type deployment_branch_policy: "$ref": "#/components/schemas/deployment-branch-policy-settings" required: - id - node_id - name - url - html_url - created_at - updated_at prevent-self-review: type: boolean example: false description: Whether or not a user who created the job is prevented from approving their own job. deployment-branch-policy: title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object properties: id: description: The unique identifier of the branch or tag policy. type: integer example: 361471 node_id: type: string example: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= name: description: The name pattern that branches or tags must match in order to deploy to the environment. type: string example: release/* type: description: Whether this rule targets a branch or tag. type: string example: branch enum: - branch - tag deployment-branch-policy-name-pattern-with-type: title: Deployment branch and tag policy name pattern type: object properties: name: description: |- The name pattern that branches or tags must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). type: string example: release/* type: description: Whether this rule targets a branch or tag type: string example: branch enum: - branch - tag required: - name deployment-branch-policy-name-pattern: title: Deployment branch policy name pattern type: object properties: name: description: |- The name pattern that branches must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). type: string example: release/* required: - name custom-deployment-rule-app: title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. type: object properties: id: type: integer example: 3515 description: The unique identifier of the deployment protection rule integration. slug: type: string example: my-custom-app description: The slugified name of the deployment protection rule integration. integration_url: type: string example: https://api.github.com/apps/custom-app-slug description: The URL for the endpoint to get details about the app. node_id: type: string example: MDQ6R2F0ZTM1MTU= description: The node ID for the deployment protection rule integration. required: - id - slug - integration_url - node_id deployment-protection-rule: title: Deployment protection rule description: Deployment protection rule type: object properties: id: type: integer example: 3515 description: The unique identifier for the deployment protection rule. node_id: type: string example: MDQ6R2F0ZTM1MTU= description: The node ID for the deployment protection rule. enabled: type: boolean example: true description: Whether the deployment protection rule is enabled for the environment. app: "$ref": "#/components/schemas/custom-deployment-rule-app" required: - id - node_id - enabled - app short-blob: title: Short Blob description: Short Blob type: object properties: url: type: string sha: type: string required: - url - sha blob: title: Blob description: Blob type: object properties: content: type: string encoding: type: string url: type: string format: uri sha: type: string size: type: integer nullable: true node_id: type: string highlighted_content: type: string required: - sha - url - node_id - size - content - encoding git-commit: title: Git Commit description: Low-level Git commit operations within a repository type: object properties: sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string node_id: type: string url: type: string format: uri author: description: Identifying information for the git-user type: object properties: date: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string email: type: string description: Git email address of the user example: monalisa.octocat@example.com name: description: Name of the git user example: Monalisa Octocat type: string required: - email - name - date committer: description: Identifying information for the git-user type: object properties: date: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string email: type: string description: Git email address of the user example: monalisa.octocat@example.com name: description: Name of the git user example: Monalisa Octocat type: string required: - email - name - date message: description: Message describing the purpose of the commit example: 'Fix #42' type: string tree: type: object properties: sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string url: type: string format: uri required: - sha - url parents: type: array items: type: object properties: sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string url: type: string format: uri html_url: type: string format: uri required: - sha - url - html_url verification: type: object properties: verified: type: boolean reason: type: string signature: type: string nullable: true payload: type: string nullable: true verified_at: type: string nullable: true required: - verified - reason - signature - payload - verified_at html_url: type: string format: uri required: - sha - node_id - url - html_url - author - committer - tree - message - parents - verification git-ref: title: Git Reference description: Git references within a repository type: object properties: ref: type: string node_id: type: string url: type: string format: uri object: type: object properties: type: type: string sha: description: SHA for the reference example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string minLength: 40 maxLength: 40 url: type: string format: uri required: - type - sha - url required: - ref - node_id - url - object git-tag: title: Git Tag description: Metadata for a Git tag type: object properties: node_id: type: string example: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: description: Name of the tag example: v0.0.1 type: string sha: type: string example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac url: description: URL for the tag example: https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac type: string format: uri message: description: Message describing the purpose of the tag example: Initial public release type: string tagger: type: object properties: date: type: string email: type: string name: type: string required: - date - email - name object: type: object properties: sha: type: string type: type: string url: type: string format: uri required: - sha - type - url verification: "$ref": "#/components/schemas/verification" required: - sha - url - node_id - tagger - object - tag - message git-tree: title: Git Tree description: The hierarchy between files in a Git repository. type: object properties: sha: type: string url: type: string format: uri truncated: type: boolean tree: description: Objects specifying a tree structure type: array items: type: object required: - path - mode - type - sha properties: path: type: string example: test/file.rb mode: type: string example: '040000' type: type: string example: tree sha: type: string example: 23f6827669e43831def8a7ad935069c8bd418261 size: type: integer example: 12 url: type: string example: https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 example: - path: file.rb mode: '100644' type: blob size: 30 sha: 44b4fc6d56897b048c772eb4087f854f46256132 url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 required: - sha - tree - truncated hook-response: title: Hook Response type: object properties: code: type: integer nullable: true status: type: string nullable: true message: type: string nullable: true required: - code - status - message hook: title: Webhook description: Webhooks for repositories. type: object properties: type: type: string id: description: Unique identifier of the webhook. example: 42 type: integer name: description: The name of a valid service, use 'web' for a webhook. example: web type: string active: description: Determines whether the hook is actually triggered on pushes. type: boolean example: true events: description: 'Determines what events the hook is triggered for. Default: [''push''].' type: array items: type: string example: - push - pull_request config: "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time example: '2011-09-06T20:39:23Z' created_at: type: string format: date-time example: '2011-09-06T17:26:27Z' url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1 test_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/test ping_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/pings deliveries_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries last_response: "$ref": "#/components/schemas/hook-response" required: - id - url - type - name - active - events - config - ping_url - created_at - updated_at - last_response - test_url check-immutable-releases: title: Check immutable releases description: Check immutable releases type: object properties: enabled: type: boolean example: true description: Whether immutable releases are enabled for the repository. enforced_by_owner: type: boolean example: false description: Whether immutable releases are enforced by the repository owner. required: - enabled - enforced_by_owner import: title: Import description: A repository import from an external source. type: object properties: vcs: type: string nullable: true use_lfs: type: boolean vcs_url: description: The URL of the originating repository. type: string svc_root: type: string tfvc_project: type: string status: type: string enum: - auth - error - none - detecting - choose - auth_failed - importing - mapping - waiting_to_push - pushing - complete - setup - unknown - detection_found_multiple - detection_found_nothing - detection_needs_auth status_text: type: string nullable: true failed_step: type: string nullable: true error_message: type: string nullable: true import_percent: type: integer nullable: true commit_count: type: integer nullable: true push_percent: type: integer nullable: true has_large_files: type: boolean large_files_size: type: integer large_files_count: type: integer project_choices: type: array items: type: object properties: vcs: type: string tfvc_project: type: string human_name: type: string message: type: string authors_count: type: integer nullable: true url: type: string format: uri html_url: type: string format: uri authors_url: type: string format: uri repository_url: type: string format: uri svn_root: type: string required: - vcs - vcs_url - status - url - repository_url - html_url - authors_url porter-author: title: Porter Author description: Porter Author type: object properties: id: type: integer remote_id: type: string remote_name: type: string email: type: string name: type: string url: type: string format: uri import_url: type: string format: uri required: - id - remote_id - remote_name - email - name - url - import_url porter-large-file: title: Porter Large File description: Porter Large File type: object properties: ref_name: type: string path: type: string oid: type: string size: type: integer required: - oid - path - ref_name - size nullable-issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object properties: id: type: integer format: int64 node_id: type: string url: description: URL for the issue example: https://api.github.com/repositories/42/issues/1 type: string format: uri repository_url: type: string format: uri labels_url: type: string comments_url: type: string format: uri events_url: type: string format: uri html_url: type: string format: uri number: description: Number uniquely identifying the issue within its repository example: 42 type: integer state: description: State of the issue; either 'open' or 'closed' example: open type: string state_reason: description: The reason for the current state example: not_planned type: string nullable: true enum: - completed - reopened - not_planned - duplicate title: description: Title of the issue example: Widget creation fails in Safari on OS X 10.8 type: string body: description: Contents of the issue example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? type: string nullable: true user: "$ref": "#/components/schemas/nullable-simple-user" labels: description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository example: - bug - registration type: array items: oneOf: - type: string - type: object properties: id: type: integer format: int64 node_id: type: string url: type: string format: uri name: type: string description: type: string nullable: true color: type: string nullable: true default: type: boolean assignee: "$ref": "#/components/schemas/nullable-simple-user" assignees: type: array items: "$ref": "#/components/schemas/simple-user" nullable: true milestone: "$ref": "#/components/schemas/nullable-milestone" locked: type: boolean active_lock_reason: type: string nullable: true comments: type: integer pull_request: type: object properties: merged_at: type: string format: date-time nullable: true diff_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true patch_url: type: string format: uri nullable: true url: type: string format: uri nullable: true required: - diff_url - html_url - patch_url - url closed_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time draft: type: boolean closed_by: "$ref": "#/components/schemas/nullable-simple-user" body_html: type: string body_text: type: string timeline_url: type: string format: uri type: "$ref": "#/components/schemas/issue-type" repository: "$ref": "#/components/schemas/repository" performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" author_association: "$ref": "#/components/schemas/author-association" reactions: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" parent_issue_url: description: URL to get the parent issue of this issue, if it is a sub-issue type: string format: uri nullable: true issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" issue_field_values: type: array items: "$ref": "#/components/schemas/issue-field-value" required: - assignee - closed_at - comments - comments_url - events_url - html_url - id - node_id - labels - labels_url - milestone - number - repository_url - state - locked - title - url - user - created_at - updated_at nullable: true issue-event-label: title: Issue Event Label description: Issue Event Label type: object properties: name: type: string nullable: true color: type: string nullable: true required: - name - color issue-event-dismissed-review: title: Issue Event Dismissed Review type: object properties: state: type: string review_id: type: integer dismissal_message: type: string nullable: true dismissal_commit_id: type: string nullable: true required: - state - review_id - dismissal_message issue-event-milestone: title: Issue Event Milestone description: Issue Event Milestone type: object properties: title: type: string required: - title issue-event-project-card: title: Issue Event Project Card description: Issue Event Project Card type: object properties: url: type: string format: uri id: type: integer project_url: type: string format: uri project_id: type: integer column_name: type: string previous_column_name: type: string required: - url - id - project_url - project_id - column_name issue-event-rename: title: Issue Event Rename description: Issue Event Rename type: object properties: from: type: string to: type: string required: - from - to issue-event: title: Issue Event description: Issue Event type: object properties: id: type: integer format: int64 example: 1 node_id: type: string example: MDEwOklzc3VlRXZlbnQx url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/events/1 actor: "$ref": "#/components/schemas/nullable-simple-user" event: type: string example: closed commit_id: type: string example: 6dcb09b5b57875f334f61aebed695e2e4193db5e nullable: true commit_url: type: string example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e nullable: true created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' issue: "$ref": "#/components/schemas/nullable-issue" label: "$ref": "#/components/schemas/issue-event-label" assignee: "$ref": "#/components/schemas/nullable-simple-user" assigner: "$ref": "#/components/schemas/nullable-simple-user" review_requester: "$ref": "#/components/schemas/nullable-simple-user" requested_reviewer: "$ref": "#/components/schemas/nullable-simple-user" requested_team: "$ref": "#/components/schemas/team" dismissed_review: "$ref": "#/components/schemas/issue-event-dismissed-review" milestone: "$ref": "#/components/schemas/issue-event-milestone" project_card: "$ref": "#/components/schemas/issue-event-project-card" rename: "$ref": "#/components/schemas/issue-event-rename" author_association: "$ref": "#/components/schemas/author-association" lock_reason: type: string nullable: true performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" required: - id - node_id - url - actor - event - commit_id - commit_url - created_at labeled-issue-event: title: Labeled Issue Event description: Labeled Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" label: type: object properties: name: type: string color: type: string required: - name - color required: - label - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app unlabeled-issue-event: title: Unlabeled Issue Event description: Unlabeled Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" label: type: object properties: name: type: string color: type: string required: - name - color required: - label - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app assigned-issue-event: title: Assigned Issue Event description: Assigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/integration" assignee: "$ref": "#/components/schemas/simple-user" assigner: "$ref": "#/components/schemas/simple-user" required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee - assigner unassigned-issue-event: title: Unassigned Issue Event description: Unassigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" assignee: "$ref": "#/components/schemas/simple-user" assigner: "$ref": "#/components/schemas/simple-user" required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee - assigner milestoned-issue-event: title: Milestoned Issue Event description: Milestoned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" milestone: type: object properties: title: type: string required: - title required: - milestone - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app demilestoned-issue-event: title: Demilestoned Issue Event description: Demilestoned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" milestone: type: object properties: title: type: string required: - title required: - milestone - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app renamed-issue-event: title: Renamed Issue Event description: Renamed Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" rename: type: object properties: from: type: string to: type: string required: - from - to required: - rename - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app review-requested-issue-event: title: Review Requested Issue Event description: Review Requested Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" review_requester: "$ref": "#/components/schemas/simple-user" requested_team: "$ref": "#/components/schemas/team" requested_reviewer: "$ref": "#/components/schemas/simple-user" required: - review_requester - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app review-request-removed-issue-event: title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" review_requester: "$ref": "#/components/schemas/simple-user" requested_team: "$ref": "#/components/schemas/team" requested_reviewer: "$ref": "#/components/schemas/simple-user" required: - review_requester - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app review-dismissed-issue-event: title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" dismissed_review: type: object properties: state: type: string review_id: type: integer dismissal_message: nullable: true type: string dismissal_commit_id: type: string required: - state - review_id - dismissal_message required: - dismissed_review - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app locked-issue-event: title: Locked Issue Event description: Locked Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" lock_reason: type: string example: '"off-topic"' nullable: true required: - lock_reason - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app added-to-project-issue-event: title: Added to Project Issue Event description: Added to Project Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app moved-column-in-project-issue-event: title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app removed-from-project-issue-event: title: Removed from Project Issue Event description: Removed from Project Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app converted-note-to-issue-issue-event: title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/integration" project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app issue-event-for-issue: title: Issue Event for Issue description: Issue Event for Issue anyOf: - "$ref": "#/components/schemas/labeled-issue-event" - "$ref": "#/components/schemas/unlabeled-issue-event" - "$ref": "#/components/schemas/assigned-issue-event" - "$ref": "#/components/schemas/unassigned-issue-event" - "$ref": "#/components/schemas/milestoned-issue-event" - "$ref": "#/components/schemas/demilestoned-issue-event" - "$ref": "#/components/schemas/renamed-issue-event" - "$ref": "#/components/schemas/review-requested-issue-event" - "$ref": "#/components/schemas/review-request-removed-issue-event" - "$ref": "#/components/schemas/review-dismissed-issue-event" - "$ref": "#/components/schemas/locked-issue-event" - "$ref": "#/components/schemas/added-to-project-issue-event" - "$ref": "#/components/schemas/moved-column-in-project-issue-event" - "$ref": "#/components/schemas/removed-from-project-issue-event" - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" label: title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). type: object properties: id: description: Unique identifier for the label. type: integer format: int64 example: 208045946 node_id: type: string example: MDU6TGFiZWwyMDgwNDU5NDY= url: description: URL for the label example: https://api.github.com/repositories/42/labels/bug type: string format: uri name: description: The name of the label. example: bug type: string description: description: Optional description of the label, such as its purpose. type: string example: Something isn't working nullable: true color: description: '6-character hex code, without the leading #, identifying the color' example: FFFFFF type: string default: description: Whether this label comes by default in a new repository. type: boolean example: true required: - id - node_id - url - name - description - color - default timeline-comment-event: title: Timeline Comment Event description: Timeline Comment Event type: object properties: event: type: string actor: "$ref": "#/components/schemas/simple-user" id: description: Unique identifier of the issue comment example: 42 type: integer node_id: type: string url: description: URL for the issue comment example: https://api.github.com/repositories/42/issues/comments/1 type: string format: uri body: description: Contents of the issue comment example: What version of Safari were you using when you observed this bug? type: string body_text: type: string body_html: type: string html_url: type: string format: uri user: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' updated_at: type: string format: date-time example: '2011-04-14T16:00:49Z' issue_url: type: string format: uri author_association: "$ref": "#/components/schemas/author-association" performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" reactions: "$ref": "#/components/schemas/reaction-rollup" required: - event - actor - id - node_id - html_url - issue_url - author_association - user - url - created_at - updated_at timeline-cross-referenced-event: title: Timeline Cross Referenced Event description: Timeline Cross Referenced Event type: object properties: event: type: string actor: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time updated_at: type: string format: date-time source: type: object properties: type: type: string issue: "$ref": "#/components/schemas/issue" required: - event - created_at - updated_at - source timeline-committed-event: title: Timeline Committed Event description: Timeline Committed Event type: object properties: event: type: string sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string node_id: type: string url: type: string format: uri author: description: Identifying information for the git-user type: object properties: date: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string email: type: string description: Git email address of the user example: monalisa.octocat@example.com name: description: Name of the git user example: Monalisa Octocat type: string required: - email - name - date committer: description: Identifying information for the git-user type: object properties: date: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string email: type: string description: Git email address of the user example: monalisa.octocat@example.com name: description: Name of the git user example: Monalisa Octocat type: string required: - email - name - date message: description: Message describing the purpose of the commit example: 'Fix #42' type: string tree: type: object properties: sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string url: type: string format: uri required: - sha - url parents: type: array items: type: object properties: sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string url: type: string format: uri html_url: type: string format: uri required: - sha - url - html_url verification: type: object properties: verified: type: boolean reason: type: string signature: type: string nullable: true payload: type: string nullable: true verified_at: type: string nullable: true required: - verified - reason - signature - payload - verified_at html_url: type: string format: uri required: - sha - node_id - url - html_url - author - committer - tree - message - parents - verification timeline-reviewed-event: title: Timeline Reviewed Event description: Timeline Reviewed Event type: object properties: event: type: string id: description: Unique identifier of the review example: 42 type: integer node_id: type: string example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= user: "$ref": "#/components/schemas/simple-user" body: nullable: true description: The text of the review. example: This looks great. type: string state: type: string example: CHANGES_REQUESTED html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 pull_request_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/12 _links: type: object properties: html: type: object properties: href: type: string required: - href pull_request: type: object properties: href: type: string required: - href required: - html - pull_request submitted_at: type: string format: date-time updated_at: type: string nullable: true format: date-time commit_id: description: A commit SHA for the review. example: 54bb654c9e6025347f57900a4a5c2313a96b8035 type: string body_html: type: string body_text: type: string author_association: "$ref": "#/components/schemas/author-association" required: - event - id - node_id - user - body - state - commit_id - html_url - pull_request_url - _links - author_association pull-request-review-comment: title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object properties: url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 type: string pull_request_review_id: description: The ID of the pull request review to which the comment belongs. type: integer format: int64 example: 42 nullable: true id: description: The ID of the pull request review comment. type: integer format: int64 example: 1 node_id: description: The node ID of the pull request review comment. type: string example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw diff_hunk: description: The diff of the line that the comment refers to. type: string example: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." path: description: The relative path of the file to which the comment applies. example: config/database.yaml type: string position: description: The line index in the diff to which the comment applies. This field is closing down; use `line` instead. example: 1 type: integer original_position: description: The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. example: 4 type: integer commit_id: description: The SHA of the commit to which the comment applies. example: 6dcb09b5b57875f334f61aebed695e2e4193db5e type: string original_commit_id: description: The SHA of the original commit to which the comment applies. example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 type: string in_reply_to_id: description: The comment ID to reply to. example: 8 type: integer user: "$ref": "#/components/schemas/simple-user" body: description: The text of the comment. example: We should probably include a check for null values here. type: string created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' updated_at: type: string format: date-time example: '2011-04-14T16:00:49Z' html_url: description: HTML URL for the pull request review comment. type: string format: uri example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 pull_request_url: description: URL for the pull request that the review comment belongs to. type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 author_association: "$ref": "#/components/schemas/author-association" _links: type: object properties: self: type: object properties: href: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 required: - href html: type: object properties: href: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 required: - href pull_request: type: object properties: href: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 required: - href required: - self - html - pull_request start_line: type: integer description: The first line of the range for a multi-line comment. example: 2 nullable: true original_start_line: type: integer description: The first line of the range for a multi-line comment. example: 2 nullable: true start_side: type: string description: The side of the first line of the range for a multi-line comment. enum: - LEFT - RIGHT default: RIGHT nullable: true line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment example: 2 type: integer original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment example: 2 type: integer side: description: The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment enum: - LEFT - RIGHT default: RIGHT type: string subject_type: description: The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file reactions: "$ref": "#/components/schemas/reaction-rollup" body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' required: - url - id - node_id - pull_request_review_id - diff_hunk - path - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links timeline-line-commented-event: title: Timeline Line Commented Event description: Timeline Line Commented Event type: object properties: event: type: string node_id: type: string comments: type: array items: "$ref": "#/components/schemas/pull-request-review-comment" timeline-commit-commented-event: title: Timeline Commit Commented Event description: Timeline Commit Commented Event type: object properties: event: type: string node_id: type: string commit_id: type: string comments: type: array items: "$ref": "#/components/schemas/commit-comment" timeline-assigned-issue-event: title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" assignee: "$ref": "#/components/schemas/simple-user" required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee timeline-unassigned-issue-event: title: Timeline Unassigned Issue Event description: Timeline Unassigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" assignee: "$ref": "#/components/schemas/simple-user" required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee state-change-issue-event: title: State Change Issue Event description: State Change Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: "$ref": "#/components/schemas/simple-user" event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" state_reason: type: string nullable: true required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app timeline-issue-events: title: Timeline Event description: Timeline Event type: object anyOf: - "$ref": "#/components/schemas/labeled-issue-event" - "$ref": "#/components/schemas/unlabeled-issue-event" - "$ref": "#/components/schemas/milestoned-issue-event" - "$ref": "#/components/schemas/demilestoned-issue-event" - "$ref": "#/components/schemas/renamed-issue-event" - "$ref": "#/components/schemas/review-requested-issue-event" - "$ref": "#/components/schemas/review-request-removed-issue-event" - "$ref": "#/components/schemas/review-dismissed-issue-event" - "$ref": "#/components/schemas/locked-issue-event" - "$ref": "#/components/schemas/added-to-project-issue-event" - "$ref": "#/components/schemas/moved-column-in-project-issue-event" - "$ref": "#/components/schemas/removed-from-project-issue-event" - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" - "$ref": "#/components/schemas/timeline-comment-event" - "$ref": "#/components/schemas/timeline-cross-referenced-event" - "$ref": "#/components/schemas/timeline-committed-event" - "$ref": "#/components/schemas/timeline-reviewed-event" - "$ref": "#/components/schemas/timeline-line-commented-event" - "$ref": "#/components/schemas/timeline-commit-commented-event" - "$ref": "#/components/schemas/timeline-assigned-issue-event" - "$ref": "#/components/schemas/timeline-unassigned-issue-event" - "$ref": "#/components/schemas/state-change-issue-event" deploy-key: title: Deploy Key description: An SSH key granting access to a single repository. type: object properties: id: type: integer key: type: string url: type: string title: type: string verified: type: boolean created_at: type: string read_only: type: boolean added_by: type: string nullable: true last_used: nullable: true type: string format: date-time enabled: type: boolean required: - id - key - url - title - verified - created_at - read_only language: title: Language description: Language type: object additionalProperties: type: integer license-content: title: License Content description: License Content type: object properties: name: type: string path: type: string sha: type: string size: type: integer url: type: string format: uri html_url: type: string format: uri nullable: true git_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true type: type: string content: type: string encoding: type: string _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self license: "$ref": "#/components/schemas/nullable-license-simple" required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url - content - encoding - license merged-upstream: title: Merged upstream description: Results of a successful merge upstream request type: object properties: message: type: string merge_type: type: string enum: - merge - fast-forward - none base_branch: type: string milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: type: string format: uri example: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: type: integer example: 1002604 node_id: type: string example: MDk6TWlsZXN0b25lMTAwMjYwNA== number: description: The number of the milestone. type: integer example: 42 state: description: The state of the milestone. example: open type: string enum: - open - closed default: open title: description: The title of the milestone. example: v1.0 type: string description: type: string example: Tracking milestone for version 1.0 nullable: true creator: "$ref": "#/components/schemas/nullable-simple-user" open_issues: type: integer example: 4 closed_issues: type: integer example: 8 created_at: type: string format: date-time example: '2011-04-10T20:09:31Z' updated_at: type: string format: date-time example: '2014-03-03T18:58:10Z' closed_at: type: string format: date-time example: '2013-02-12T13:22:01Z' nullable: true due_on: type: string format: date-time example: '2012-10-09T23:39:01Z' nullable: true required: - closed_issues - creator - description - due_on - closed_at - id - node_id - labels_url - html_url - number - open_issues - state - title - url - created_at - updated_at pages-source-hash: title: Pages Source Hash type: object properties: branch: type: string path: type: string required: - branch - path pages-https-certificate: title: Pages Https Certificate type: object properties: state: type: string enum: - new - authorization_created - authorization_pending - authorized - authorization_revoked - issued - uploaded - approved - errored - bad_authz - destroy_pending - dns_changed example: approved description: type: string example: Certificate is approved domains: type: array items: type: string description: Array of the domain set and its alternate name (if it is configured) example: - example.com - www.example.com expires_at: type: string format: date required: - state - description - domains page: title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object properties: url: type: string description: The API address for accessing this Page resource. format: uri example: https://api.github.com/repos/github/hello-world/pages status: type: string description: The status of the most recent build of the Page. example: built enum: - built - building - errored nullable: true cname: description: The Pages site's custom domain example: example.com type: string nullable: true protected_domain_state: type: string description: The state if the domain is verified example: pending nullable: true enum: - pending - verified - unverified pending_domain_unverified_at: type: string description: The timestamp when a pending domain becomes unverified. nullable: true format: date-time custom_404: type: boolean description: Whether the Page has a custom 404 page. example: false default: false html_url: type: string description: The web address the Page can be accessed from. format: uri example: https://example.com build_type: type: string description: The process in which the Page will be built. example: legacy nullable: true enum: - legacy - workflow source: "$ref": "#/components/schemas/pages-source-hash" public: type: boolean description: Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. example: true https_certificate: "$ref": "#/components/schemas/pages-https-certificate" https_enforced: type: boolean description: Whether https is enabled on the domain example: true required: - url - status - cname - custom_404 - public page-build: title: Page Build description: Page Build type: object properties: url: type: string format: uri status: type: string error: type: object properties: message: type: string nullable: true required: - message pusher: "$ref": "#/components/schemas/nullable-simple-user" commit: type: string duration: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time required: - url - status - error - pusher - commit - duration - created_at - updated_at page-build-status: title: Page Build Status description: Page Build Status type: object properties: url: type: string format: uri example: https://api.github.com/repos/github/hello-world/pages/builds/latest status: type: string example: queued required: - url - status page-deployment: title: GitHub Pages description: The GitHub Pages deployment status. type: object properties: id: oneOf: - type: integer - type: string description: The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. status_url: type: string description: The URI to monitor GitHub Pages deployment status. format: uri example: https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 page_url: type: string description: The URI to the deployed GitHub Pages. format: uri example: hello-world.github.io preview_url: type: string description: The URI to the deployed GitHub Pages preview. format: uri example: monalisa-1231a2312sa32-23sda74.drafts.github.io required: - id - status_url - page_url pages-deployment-status: title: GitHub Pages deployment status type: object properties: status: type: string description: The current status of the deployment. enum: - deployment_in_progress - syncing_files - finished_file_sync - updating_pages - purging_cdn - deployment_cancelled - deployment_failed - deployment_content_failed - deployment_attempt_error - deployment_lost - succeed pages-health-check: title: Pages Health Check Status description: Pages Health Check Status type: object properties: domain: type: object properties: host: type: string uri: type: string nameservers: type: string dns_resolves: type: boolean is_proxied: type: boolean nullable: true is_cloudflare_ip: type: boolean nullable: true is_fastly_ip: type: boolean nullable: true is_old_ip_address: type: boolean nullable: true is_a_record: type: boolean nullable: true has_cname_record: type: boolean nullable: true has_mx_records_present: type: boolean nullable: true is_valid_domain: type: boolean is_apex_domain: type: boolean should_be_a_record: type: boolean nullable: true is_cname_to_github_user_domain: type: boolean nullable: true is_cname_to_pages_dot_github_dot_com: type: boolean nullable: true is_cname_to_fastly: type: boolean nullable: true is_pointed_to_github_pages_ip: type: boolean nullable: true is_non_github_pages_ip_present: type: boolean nullable: true is_pages_domain: type: boolean is_served_by_pages: type: boolean nullable: true is_valid: type: boolean reason: type: string nullable: true responds_to_https: type: boolean enforces_https: type: boolean https_error: type: string nullable: true is_https_eligible: type: boolean nullable: true caa_error: type: string nullable: true alt_domain: type: object nullable: true properties: host: type: string uri: type: string nameservers: type: string dns_resolves: type: boolean is_proxied: type: boolean nullable: true is_cloudflare_ip: type: boolean nullable: true is_fastly_ip: type: boolean nullable: true is_old_ip_address: type: boolean nullable: true is_a_record: type: boolean nullable: true has_cname_record: type: boolean nullable: true has_mx_records_present: type: boolean nullable: true is_valid_domain: type: boolean is_apex_domain: type: boolean should_be_a_record: type: boolean nullable: true is_cname_to_github_user_domain: type: boolean nullable: true is_cname_to_pages_dot_github_dot_com: type: boolean nullable: true is_cname_to_fastly: type: boolean nullable: true is_pointed_to_github_pages_ip: type: boolean nullable: true is_non_github_pages_ip_present: type: boolean nullable: true is_pages_domain: type: boolean is_served_by_pages: type: boolean nullable: true is_valid: type: boolean reason: type: string nullable: true responds_to_https: type: boolean enforces_https: type: boolean https_error: type: string nullable: true is_https_eligible: type: boolean nullable: true caa_error: type: string nullable: true pull-request: type: object title: Pull Request description: Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer format: int64 example: 1 node_id: type: string example: MDExOlB1bGxSZXF1ZXN0MQ== html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347 diff_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.patch issue_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/1347 commits_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits review_comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments review_comment_url: type: string example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e number: description: Number uniquely identifying the pull request within its repository. example: 42 type: integer state: description: State of this Pull Request. Either `open` or `closed`. enum: - open - closed example: open type: string locked: type: boolean example: true title: description: The title of the pull request. example: Amazing new feature type: string user: "$ref": "#/components/schemas/simple-user" body: type: string example: Please pull these awesome changes nullable: true labels: type: array items: type: object properties: id: type: integer format: int64 node_id: type: string url: type: string name: type: string description: type: string nullable: true color: type: string default: type: boolean required: - id - node_id - url - name - description - color - default milestone: "$ref": "#/components/schemas/nullable-milestone" active_lock_reason: type: string example: too heated nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:01:12Z' closed_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true merged_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true merge_commit_sha: type: string example: e5bd3914e2e596debea16f433f57875b5b90bcd6 nullable: true assignee: "$ref": "#/components/schemas/nullable-simple-user" assignees: type: array items: "$ref": "#/components/schemas/simple-user" nullable: true requested_reviewers: type: array items: "$ref": "#/components/schemas/simple-user" nullable: true requested_teams: type: array items: "$ref": "#/components/schemas/team-simple" nullable: true head: type: object properties: label: type: string ref: type: string repo: "$ref": "#/components/schemas/repository" sha: type: string user: "$ref": "#/components/schemas/simple-user" required: - label - ref - repo - sha - user base: type: object properties: label: type: string ref: type: string repo: "$ref": "#/components/schemas/repository" sha: type: string user: "$ref": "#/components/schemas/simple-user" required: - label - ref - repo - sha - user _links: type: object properties: comments: "$ref": "#/components/schemas/link" commits: "$ref": "#/components/schemas/link" statuses: "$ref": "#/components/schemas/link" html: "$ref": "#/components/schemas/link" issue: "$ref": "#/components/schemas/link" review_comments: "$ref": "#/components/schemas/link" review_comment: "$ref": "#/components/schemas/link" self: "$ref": "#/components/schemas/link" required: - comments - commits - statuses - html - issue - review_comments - review_comment - self author_association: "$ref": "#/components/schemas/author-association" auto_merge: "$ref": "#/components/schemas/auto-merge" draft: description: Indicates whether or not the pull request is a draft. example: false type: boolean merged: type: boolean mergeable: type: boolean example: true nullable: true rebaseable: type: boolean example: true nullable: true mergeable_state: type: string example: clean merged_by: "$ref": "#/components/schemas/nullable-simple-user" comments: type: integer example: 10 review_comments: type: integer example: 0 maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. example: true type: boolean commits: type: integer example: 3 additions: type: integer example: 100 deletions: type: integer example: 3 changed_files: type: integer example: 5 required: - _links - assignee - labels - base - body - closed_at - comments_url - commits_url - created_at - diff_url - head - html_url - id - node_id - issue_url - merge_commit_sha - merged_at - milestone - number - patch_url - review_comment_url - review_comments_url - statuses_url - state - locked - title - updated_at - url - user - author_association - auto_merge - additions - changed_files - comments - commits - deletions - mergeable - mergeable_state - merged - maintainer_can_modify - merged_by - review_comments pull-request-merge-result: title: Pull Request Merge Result description: Pull Request Merge Result type: object properties: sha: type: string merged: type: boolean message: type: string required: - merged - message - sha pull-request-review-request: title: Pull Request Review Request description: Pull Request Review Request type: object properties: users: type: array items: "$ref": "#/components/schemas/simple-user" teams: type: array items: "$ref": "#/components/schemas/team" required: - users - teams pull-request-review: title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object properties: id: description: Unique identifier of the review example: 42 type: integer format: int64 node_id: type: string example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= user: "$ref": "#/components/schemas/nullable-simple-user" body: description: The text of the review. example: This looks great. type: string state: type: string example: CHANGES_REQUESTED html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 pull_request_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/12 _links: type: object properties: html: type: object properties: href: type: string required: - href pull_request: type: object properties: href: type: string required: - href required: - html - pull_request submitted_at: type: string format: date-time commit_id: description: A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. example: 54bb654c9e6025347f57900a4a5c2313a96b8035 type: string nullable: true body_html: type: string body_text: type: string author_association: "$ref": "#/components/schemas/author-association" required: - id - node_id - user - body - state - commit_id - html_url - pull_request_url - _links - author_association review-comment: title: Legacy Review Comment description: Legacy Review Comment type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: type: integer format: int64 example: 42 nullable: true id: type: integer format: int64 example: 10 node_id: type: string example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw diff_hunk: type: string example: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." path: type: string example: file1.txt position: type: integer example: 1 nullable: true original_position: type: integer example: 4 commit_id: type: string example: 6dcb09b5b57875f334f61aebed695e2e4193db5e original_commit_id: type: string example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 in_reply_to_id: type: integer example: 8 user: "$ref": "#/components/schemas/nullable-simple-user" body: type: string example: Great stuff created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' updated_at: type: string format: date-time example: '2011-04-14T16:00:49Z' html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 pull_request_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 author_association: "$ref": "#/components/schemas/author-association" _links: type: object properties: self: "$ref": "#/components/schemas/link" html: "$ref": "#/components/schemas/link" pull_request: "$ref": "#/components/schemas/link" required: - self - html - pull_request body_text: type: string body_html: type: string reactions: "$ref": "#/components/schemas/reaction-rollup" side: description: The side of the first line of the range for a multi-line comment. enum: - LEFT - RIGHT default: RIGHT type: string start_side: type: string description: The side of the first line of the range for a multi-line comment. enum: - LEFT - RIGHT default: RIGHT nullable: true line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment example: 2 type: integer original_line: description: The original line of the blob to which the comment applies. The last line of the range for a multi-line comment example: 2 type: integer start_line: description: The first line of the range for a multi-line comment. example: 2 type: integer nullable: true original_start_line: description: The original first line of the range for a multi-line comment. example: 2 type: integer nullable: true subject_type: description: The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file required: - id - node_id - url - body - diff_hunk - path - position - original_position - commit_id - original_commit_id - user - pull_request_review_id - html_url - pull_request_url - _links - author_association - created_at - updated_at release-asset: title: Release Asset description: Data related to a release. type: object properties: url: type: string format: uri browser_download_url: type: string format: uri id: type: integer node_id: type: string name: description: The file name of the asset. type: string example: Team Environment label: type: string nullable: true state: description: State of the release asset. type: string enum: - uploaded - open content_type: type: string size: type: integer digest: type: string nullable: true download_count: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time uploader: "$ref": "#/components/schemas/nullable-simple-user" required: - id - name - content_type - size - digest - state - url - node_id - download_count - label - uploader - browser_download_url - created_at - updated_at release: title: Release description: A release. type: object properties: url: type: string format: uri html_url: type: string format: uri assets_url: type: string format: uri upload_url: type: string tarball_url: type: string format: uri nullable: true zipball_url: type: string format: uri nullable: true id: type: integer node_id: type: string tag_name: description: The name of the tag. example: v1.0.0 type: string target_commitish: description: Specifies the commitish value that determines where the Git tag is created from. example: master type: string name: type: string nullable: true body: type: string nullable: true draft: description: true to create a draft (unpublished) release, false to create a published one. example: false type: boolean prerelease: description: Whether to identify the release as a prerelease or a full release. example: false type: boolean immutable: description: Whether or not the release is immutable. example: false type: boolean created_at: type: string format: date-time published_at: type: string format: date-time nullable: true updated_at: type: string nullable: true format: date-time author: "$ref": "#/components/schemas/simple-user" assets: type: array items: "$ref": "#/components/schemas/release-asset" body_html: type: string body_text: type: string mentions_count: type: integer discussion_url: description: The URL of the release discussion. type: string format: uri reactions: "$ref": "#/components/schemas/reaction-rollup" required: - assets_url - upload_url - tarball_url - zipball_url - created_at - published_at - draft - id - node_id - author - html_url - name - prerelease - tag_name - target_commitish - assets - url release-notes-content: title: Generated Release Notes Content description: Generated name and body describing a release type: object properties: name: description: The generated name of the release type: string example: Release v1.0.0 is now available! body: description: The generated body describing the contents of the release supporting markdown formatting type: string required: - name - body repository-rule-ruleset-info: title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. properties: ruleset_source_type: type: string description: The type of source for the ruleset that includes this rule. enum: - Repository - Organization ruleset_source: type: string description: The name of the source of the ruleset that includes this rule. ruleset_id: type: integer description: The ID of the ruleset that includes this rule. repository-rule-detailed: title: Repository Rule type: object description: A repository rule with ruleset details. oneOf: - allOf: - "$ref": "#/components/schemas/repository-rule-creation" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-update" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-deletion" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-required-linear-history" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-merge-queue" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-required-deployments" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-required-signatures" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-pull-request" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-required-status-checks" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-non-fast-forward" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-code-scanning" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-copilot-code-review" - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object properties: number: "$ref": "#/components/schemas/alert-number" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/nullable-alert-updated-at" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. state: "$ref": "#/components/schemas/secret-scanning-alert-state" resolution: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolved_at: type: string format: date-time description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true resolved_by: "$ref": "#/components/schemas/nullable-simple-user" resolution_comment: type: string description: An optional comment to resolve an alert. nullable: true secret_type: type: string description: The type of secret that secret scanning detected. secret_type_display_name: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." secret: type: string description: The secret that was detected. push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected secret. nullable: true push_protection_bypassed_by: "$ref": "#/components/schemas/nullable-simple-user" push_protection_bypassed_at: type: string format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" push_protection_bypass_request_reviewer_comment: type: string description: An optional comment when reviewing a push protection bypass. nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. nullable: true push_protection_bypass_request_html_url: type: string format: uri description: The URL to a push protection bypass request. nullable: true validity: type: string description: The token status as of the latest validity check. enum: - active - inactive - unknown publicly_leaked: type: boolean description: Whether the detected secret was publicly leaked. nullable: true multi_repo: type: boolean description: Whether the detected secret was found in multiple repositories under the same organization or enterprise. nullable: true is_base64_encoded: type: boolean description: A boolean value representing whether or not alert is base64 encoded nullable: true first_location_detected: "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" has_more_locations: type: boolean description: A boolean value representing whether or not the token in the alert was detected in more than one location. assigned_to: "$ref": "#/components/schemas/nullable-simple-user" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true secret-scanning-location: type: object properties: type: type: string enum: - commit - wiki_commit - issue_title - issue_body - issue_comment - discussion_title - discussion_body - discussion_comment - pull_request_title - pull_request_body - pull_request_comment - pull_request_review - pull_request_review_comment description: The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. example: commit details: oneOf: - "$ref": "#/components/schemas/secret-scanning-location-commit" - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" secret-scanning-push-protection-bypass-reason: description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later secret-scanning-push-protection-bypass: type: object properties: reason: "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" expire_at: type: string format: date-time description: 'The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true token_type: type: string description: The token type this bypass is for. secret-scanning-scan: description: Information on a single scan performed by secret scanning on the repository type: object properties: type: type: string description: The type of scan status: type: string description: The state of the scan. Either "completed", "running", or "pending" completed_at: type: string format: date-time description: The time that the scan was completed. Empty if the scan is running nullable: true started_at: type: string format: date-time description: The time that the scan was started. Empty if the scan is pending nullable: true secret-scanning-scan-history: type: object properties: incremental_scans: type: array items: "$ref": "#/components/schemas/secret-scanning-scan" pattern_update_scans: type: array items: "$ref": "#/components/schemas/secret-scanning-scan" backfill_scans: type: array items: "$ref": "#/components/schemas/secret-scanning-scan" custom_pattern_backfill_scans: type: array items: allOf: - "$ref": "#/components/schemas/secret-scanning-scan" - type: object properties: pattern_name: type: string description: Name of the custom pattern for custom pattern scans pattern_scope: type: string description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" repository-advisory-create: type: object properties: summary: type: string description: A short summary of the advisory. maxLength: 1024 description: type: string description: A detailed description of what the advisory impacts. maxLength: 65535 cve_id: type: string description: The Common Vulnerabilities and Exposures (CVE) ID. nullable: true vulnerabilities: type: array description: A product affected by the vulnerability detailed in a repository security advisory. items: type: object properties: package: description: The name of the package affected by the vulnerability. type: object properties: ecosystem: "$ref": "#/components/schemas/security-advisory-ecosystems" name: type: string description: The unique package name within its ecosystem. nullable: true required: - ecosystem vulnerable_version_range: type: string description: The range of the package versions affected by the vulnerability. nullable: true patched_versions: type: string description: The package version(s) that resolve the vulnerability. nullable: true vulnerable_functions: type: array description: The functions in the package that are affected. nullable: true items: type: string required: - package additionalProperties: false cwe_ids: type: array description: A list of Common Weakness Enumeration (CWE) IDs. nullable: true items: type: string credits: type: array description: A list of users receiving credit for their participation in the security advisory. nullable: true items: type: object properties: login: type: string description: The username of the user credited. type: "$ref": "#/components/schemas/security-advisory-credit-types" required: - login - type additionalProperties: false severity: type: string description: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. nullable: true enum: - critical - high - medium - low cvss_vector_string: type: string description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. nullable: true start_private_fork: type: boolean description: Whether to create a temporary private fork of the repository to collaborate on a fix. default: false required: - summary - description - vulnerabilities additionalProperties: false private-vulnerability-report-create: type: object properties: summary: type: string description: A short summary of the advisory. maxLength: 1024 description: type: string description: A detailed description of what the advisory impacts. maxLength: 65535 vulnerabilities: type: array description: An array of products affected by the vulnerability detailed in a repository security advisory. nullable: true items: type: object properties: package: description: The name of the package affected by the vulnerability. type: object properties: ecosystem: "$ref": "#/components/schemas/security-advisory-ecosystems" name: type: string description: The unique package name within its ecosystem. nullable: true required: - ecosystem vulnerable_version_range: type: string description: The range of the package versions affected by the vulnerability. nullable: true patched_versions: type: string description: The package version(s) that resolve the vulnerability. nullable: true vulnerable_functions: type: array description: The functions in the package that are affected. nullable: true items: type: string required: - package additionalProperties: false cwe_ids: type: array description: A list of Common Weakness Enumeration (CWE) IDs. nullable: true items: type: string severity: type: string description: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. nullable: true enum: - critical - high - medium - low cvss_vector_string: type: string description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. nullable: true start_private_fork: type: boolean description: Whether to create a temporary private fork of the repository to collaborate on a fix. default: false required: - summary - description additionalProperties: false repository-advisory-update: type: object properties: summary: type: string description: A short summary of the advisory. maxLength: 1024 description: type: string description: A detailed description of what the advisory impacts. maxLength: 65535 cve_id: type: string description: The Common Vulnerabilities and Exposures (CVE) ID. nullable: true vulnerabilities: type: array description: A product affected by the vulnerability detailed in a repository security advisory. items: type: object properties: package: description: The name of the package affected by the vulnerability. type: object properties: ecosystem: "$ref": "#/components/schemas/security-advisory-ecosystems" name: type: string description: The unique package name within its ecosystem. nullable: true required: - ecosystem vulnerable_version_range: type: string description: The range of the package versions affected by the vulnerability. nullable: true patched_versions: type: string description: The package version(s) that resolve the vulnerability. nullable: true vulnerable_functions: type: array description: The functions in the package that are affected. nullable: true items: type: string required: - package additionalProperties: false cwe_ids: type: array description: A list of Common Weakness Enumeration (CWE) IDs. nullable: true items: type: string credits: type: array description: A list of users receiving credit for their participation in the security advisory. nullable: true items: type: object properties: login: type: string description: The username of the user credited. type: "$ref": "#/components/schemas/security-advisory-credit-types" required: - login - type additionalProperties: false severity: type: string description: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. nullable: true enum: - critical - high - medium - low cvss_vector_string: type: string description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. nullable: true state: type: string description: The state of the advisory. enum: - published - closed - draft collaborating_users: type: array description: A list of usernames who have been granted write access to the advisory. nullable: true items: type: string collaborating_teams: type: array description: A list of team slugs which have been granted write access to the advisory. nullable: true items: type: string additionalProperties: false stargazer: title: Stargazer description: Stargazer type: object properties: starred_at: type: string format: date-time user: "$ref": "#/components/schemas/nullable-simple-user" required: - starred_at - user code-frequency-stat: title: Code Frequency Stat description: Code Frequency Stat type: array items: type: integer commit-activity: title: Commit Activity description: Commit Activity type: object properties: days: type: array example: - 0 - 3 - 26 - 20 - 39 - 1 - 0 items: type: integer total: type: integer example: 89 week: type: integer example: 1336280400 required: - days - total - week contributor-activity: title: Contributor Activity description: Contributor Activity type: object properties: author: "$ref": "#/components/schemas/nullable-simple-user" total: type: integer example: 135 weeks: type: array example: - w: '1367712000' a: 6898 d: 77 c: 10 items: type: object properties: w: type: integer a: type: integer d: type: integer c: type: integer required: - author - total - weeks participation-stats: title: Participation Stats type: object properties: all: type: array items: type: integer owner: type: array items: type: integer required: - all - owner repository-subscription: title: Repository Invitation description: Repository invitations let you manage who you collaborate with. type: object properties: subscribed: description: Determines if notifications should be received from this repository. type: boolean example: true ignored: description: Determines if all notifications should be blocked from this repository. type: boolean reason: type: string nullable: true created_at: type: string format: date-time example: '2012-10-06T21:34:12Z' url: type: string format: uri example: https://api.github.com/repos/octocat/example/subscription repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example required: - created_at - ignored - reason - subscribed - url - repository_url tag: title: Tag description: Tag type: object properties: name: type: string example: v0.1 commit: type: object properties: sha: type: string url: type: string format: uri required: - sha - url zipball_url: type: string format: uri example: https://github.com/octocat/Hello-World/zipball/v0.1 tarball_url: type: string format: uri example: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: type: string required: - name - node_id - commit - zipball_url - tarball_url tag-protection: title: Tag protection description: Tag protection type: object properties: id: type: integer example: 2 created_at: type: string example: '2011-01-26T19:01:12Z' updated_at: type: string example: '2011-01-26T19:01:12Z' enabled: type: boolean example: true pattern: type: string example: v1.* required: - pattern topic: title: Topic description: A topic aggregates entities that are related to a subject. type: object properties: names: type: array items: type: string required: - names traffic: title: Traffic type: object properties: timestamp: type: string format: date-time uniques: type: integer count: type: integer required: - timestamp - uniques - count clone-traffic: title: Clone Traffic description: Clone Traffic type: object properties: count: type: integer example: 173 uniques: type: integer example: 128 clones: type: array items: "$ref": "#/components/schemas/traffic" required: - uniques - count - clones content-traffic: title: Content Traffic description: Content Traffic type: object properties: path: type: string example: "/github/hubot" title: type: string example: 'github/hubot: A customizable life embetterment robot.' count: type: integer example: 3542 uniques: type: integer example: 2225 required: - path - title - uniques - count referrer-traffic: title: Referrer Traffic description: Referrer Traffic type: object properties: referrer: type: string example: Google count: type: integer example: 4 uniques: type: integer example: 3 required: - referrer - uniques - count view-traffic: title: View Traffic description: View Traffic type: object properties: count: type: integer example: 14850 uniques: type: integer example: 3782 views: type: array items: "$ref": "#/components/schemas/traffic" required: - uniques - count - views group-response: type: object required: - schemas properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:Group - urn:ietf:params:scim:api:messages:2.0:ListResponse example: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 nullable: true displayName: type: string description: A human-readable name for a security group. example: Engineering nullable: true members: type: array description: The group members. items: type: object required: - value - "$ref" properties: value: type: string description: The local unique identifier for the member example: 23a35c27-23d3-4c03-b4c5-6443c09e7173 "$ref": type: string display: type: string description: The display name associated with the member example: Monalisa Octocat meta: type: object description: The metadata associated with the creation/updates to the user. required: - resourceType properties: resourceType: type: string description: A type of a resource enum: - User - Group example: User created: type: string description: A date and time when the user was created. example: '2022-03-27T19:59:26.000Z' lastModified: type: string description: A data and time when the user was last modified. example: '2022-03-27T19:59:26.000Z' location: type: string description: A URL location of an object scim-enterprise-group-response: allOf: - "$ref": "#/components/schemas/group-response" - type: object properties: id: type: string description: The internally generated id for the group object. example: 7fce0092-d52e-4f76-b727-3955bd72c939 members: type: array items: type: object properties: value: type: string "$ref": type: string display: type: string description: The security group members. example: - value: 879db59-3bdf-4490-ad68-ab880a2694745 "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 displayName: User 1 - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 meta: "$ref": "#/components/schemas/meta" scim-enterprise-group-list: type: object required: - schemas - totalResults - Resources - startIndex - itemsPerPage properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the list SCIM schemas. items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:ListResponse example: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: type: integer description: Number of results found example: 1 Resources: type: array description: Information about each provisioned group. items: "$ref": "#/components/schemas/scim-enterprise-group-response" startIndex: type: integer description: A starting index for the returned page example: 1 itemsPerPage: type: integer description: Number of objects per page example: 20 group: type: object required: - schemas - externalId - displayName properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:Group example: - urn:ietf:params:scim:schemas:core:2.0:Group externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 displayName: type: string description: A human-readable name for a security group. example: Engineering members: type: array description: The group members. items: type: object required: - value - displayName properties: value: type: string description: The local unique identifier for the member example: 23a35c27-23d3-4c03-b4c5-6443c09e7173 displayName: type: string description: The display name associated with the member example: Monalisa Octocat patch-schema: type: object required: - Operations - schemas properties: Operations: type: array description: patch operations list items: type: object required: - op properties: op: type: string enum: - add - replace - remove path: type: string value: type: string description: Corresponding 'value' of that field specified by 'path' schemas: type: array items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:PatchOp user-name-response: type: object properties: formatted: type: string description: The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. example: Ms. Mona Lisa Octocat familyName: type: string description: The family name of the user. example: Octocat givenName: type: string description: The given name of the user. example: Mona middleName: type: string description: The middle name(s) of the user. example: Lisa user-emails-response: type: array description: The emails for the user. items: type: object required: - value properties: value: type: string description: The email address. example: mlisa@example.com type: type: string description: The type of email address. example: work primary: type: boolean description: Whether this email address is the primary address. example: true user-role: type: array description: The roles assigned to the user. items: type: object required: - value properties: display: type: string type: type: string value: type: string description: The role value representing a user role in GitHub. enum: - user - 27d9891d-2c17-4f45-a262-781a0e55c80a - guest_collaborator - 1ebc4a02-e56c-43a6-92a5-02ee09b90824 - enterprise_owner - 981df190-8801-4618-a08a-d91f6206c954 - ba4987ab-a1c3-412a-b58c-360fc407cb10 - billing_manager - 0e338b8c-cc7f-498a-928d-ea3470d7e7e3 - e6be2762-e4ad-4108-b72d-1bbe884a0f91 example: user primary: type: boolean description: Is the role a primary role for the user. example: false user-response: type: object required: - schemas - active - emails properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User example: - urn:ietf:params:scim:schemas:core:2.0:User externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: E012345 nullable: true active: type: boolean description: Whether the user active in the IdP. example: true userName: type: string description: The username for the user. example: E012345 name: "$ref": "#/components/schemas/user-name-response" displayName: type: string description: A human-readable name for the user. example: Mona Lisa nullable: true emails: "$ref": "#/components/schemas/user-emails-response" roles: "$ref": "#/components/schemas/user-role" scim-enterprise-user-response: allOf: - "$ref": "#/components/schemas/user-response" - type: object required: - id - meta properties: id: type: string description: The internally generated id for the user object. example: 7fce0092-d52e-4f76-b727-3955bd72c939 groups: type: array items: type: object properties: value: type: string "$ref": type: string display: type: string description: Provisioned SCIM groups that the user is a member of. meta: "$ref": "#/components/schemas/meta" scim-enterprise-user-list: type: object required: - schemas - totalResults - Resources - startIndex - itemsPerPage properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the list SCIM schemas. items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:ListResponse example: - urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: type: integer description: Number of results found example: 1 Resources: type: array description: Information about each provisioned account. items: "$ref": "#/components/schemas/scim-enterprise-user-response" startIndex: type: integer description: A starting index for the returned page example: 1 itemsPerPage: type: integer description: Number of objects per page example: 20 user-name: type: object required: - familyName - givenName properties: formatted: type: string description: The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. example: Ms. Mona Lisa Octocat familyName: type: string description: The family name of the user. example: Octocat givenName: type: string description: The given name of the user. example: Mona middleName: type: string description: The middle name(s) of the user. example: Lisa user-emails: type: array description: The emails for the user. items: type: object required: - value - type - primary properties: value: type: string description: The email address. example: mlisa@example.com type: type: string description: The type of email address. example: work primary: type: boolean description: Whether this email address is the primary address. example: true user: type: object required: - schemas - externalId - userName - active - displayName - emails properties: schemas: type: array description: The URIs that are used to indicate the namespaces of the SCIM schemas. items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User example: - urn:ietf:params:scim:schemas:core:2.0:User externalId: type: string description: A unique identifier for the resource as defined by the provisioning client. example: E012345 active: type: boolean description: Whether the user active in the IdP. example: true userName: type: string description: The username for the user. example: E012345 name: "$ref": "#/components/schemas/user-name" displayName: type: string description: A human-readable name for the user. example: Mona Lisa emails: "$ref": "#/components/schemas/user-emails" roles: "$ref": "#/components/schemas/user-role" scim-user: title: SCIM /Users description: SCIM /Users provisioning endpoints type: object properties: schemas: description: SCIM schema used. type: array minItems: 1 items: type: string example: urn:ietf:params:scim:schemas:core:2.0:User id: description: Unique identifier of an external identity example: 1b78eada-9baa-11e6-9eb6-a431576d590e type: string externalId: description: The ID of the User. type: string example: a7b0f98395 nullable: true userName: description: Configured by the admin. Could be an email, login, or username example: someone@example.com type: string nullable: true displayName: description: The name of the user, suitable for display to end-users example: Jon Doe type: string nullable: true name: type: object properties: givenName: type: string nullable: true familyName: type: string nullable: true formatted: type: string nullable: true example: givenName: Jane familyName: User emails: description: user emails example: - value: someone@example.com primary: true - value: another@example.com primary: false type: array items: type: object properties: value: type: string primary: type: boolean type: type: string required: - value active: description: The active status of the User. type: boolean example: true meta: type: object properties: resourceType: type: string example: User created: type: string format: date-time example: '2019-01-24T22:45:36.000Z' lastModified: type: string format: date-time example: '2019-01-24T22:45:36.000Z' location: type: string format: uri example: https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d organization_id: description: The ID of the organization. type: integer operations: description: Set of operations to be performed example: - op: replace value: active: false type: array minItems: 1 items: properties: op: type: string enum: - add - remove - replace path: type: string value: oneOf: - type: string - type: object - type: array items: {} required: - op type: object groups: description: associated groups type: array items: type: object properties: value: type: string display: type: string roles: type: array items: type: object properties: value: type: string primary: type: boolean type: type: string display: type: string required: - id - schemas - emails - active - meta scim-user-list: title: SCIM User List description: SCIM User List type: object properties: schemas: description: SCIM schema used. type: array minItems: 1 items: type: string example: urn:ietf:params:scim:api:messages:2.0:ListResponse totalResults: type: integer example: 3 itemsPerPage: type: integer example: 10 startIndex: type: integer example: 1 Resources: type: array items: "$ref": "#/components/schemas/scim-user" required: - schemas - totalResults - itemsPerPage - startIndex - Resources search-result-text-matches: title: Search Result Text Matches type: array items: type: object properties: object_url: type: string object_type: nullable: true type: string property: type: string fragment: type: string matches: type: array items: type: object properties: text: type: string indices: type: array items: type: integer code-search-result-item: title: Code Search Result Item description: Code Search Result Item type: object properties: name: type: string path: type: string sha: type: string url: type: string format: uri git_url: type: string format: uri html_url: type: string format: uri repository: "$ref": "#/components/schemas/minimal-repository" score: type: number file_size: type: integer language: type: string nullable: true last_modified_at: type: string format: date-time line_numbers: type: array items: type: string example: - 73..77 - 77..78 text_matches: "$ref": "#/components/schemas/search-result-text-matches" required: - score - name - path - sha - git_url - html_url - url - repository commit-search-result-item: title: Commit Search Result Item description: Commit Search Result Item type: object properties: url: type: string format: uri sha: type: string html_url: type: string format: uri comments_url: type: string format: uri commit: type: object properties: author: type: object properties: name: type: string email: type: string date: type: string format: date-time required: - name - email - date committer: "$ref": "#/components/schemas/nullable-git-user" comment_count: type: integer message: type: string tree: type: object properties: sha: type: string url: type: string format: uri required: - sha - url url: type: string format: uri verification: "$ref": "#/components/schemas/verification" required: - author - committer - comment_count - message - tree - url author: "$ref": "#/components/schemas/nullable-simple-user" committer: "$ref": "#/components/schemas/nullable-git-user" parents: type: array items: type: object properties: url: type: string html_url: type: string sha: type: string repository: "$ref": "#/components/schemas/minimal-repository" score: type: number node_id: type: string text_matches: "$ref": "#/components/schemas/search-result-text-matches" required: - sha - node_id - url - html_url - author - committer - parents - comments_url - commit - repository - score issue-search-result-item: title: Issue Search Result Item description: Issue Search Result Item type: object properties: url: type: string format: uri repository_url: type: string format: uri labels_url: type: string comments_url: type: string format: uri events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 node_id: type: string number: type: integer title: type: string locked: type: boolean active_lock_reason: type: string nullable: true assignees: type: array items: "$ref": "#/components/schemas/simple-user" nullable: true user: "$ref": "#/components/schemas/nullable-simple-user" labels: type: array items: type: object properties: id: type: integer format: int64 node_id: type: string url: type: string name: type: string color: type: string default: type: boolean description: type: string nullable: true sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" issue_field_values: type: array items: "$ref": "#/components/schemas/issue-field-value" state: type: string state_reason: type: string nullable: true assignee: "$ref": "#/components/schemas/nullable-simple-user" milestone: "$ref": "#/components/schemas/nullable-milestone" comments: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time closed_at: type: string format: date-time nullable: true text_matches: "$ref": "#/components/schemas/search-result-text-matches" pull_request: type: object properties: merged_at: type: string format: date-time nullable: true diff_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true patch_url: type: string format: uri nullable: true url: type: string format: uri nullable: true required: - diff_url - html_url - patch_url - url body: type: string score: type: number author_association: "$ref": "#/components/schemas/author-association" draft: type: boolean repository: "$ref": "#/components/schemas/repository" body_html: type: string body_text: type: string timeline_url: type: string format: uri type: "$ref": "#/components/schemas/issue-type" performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" reactions: "$ref": "#/components/schemas/reaction-rollup" required: - assignee - closed_at - comments - comments_url - events_url - html_url - id - node_id - labels - labels_url - milestone - number - repository_url - state - locked - title - url - user - author_association - created_at - updated_at - score label-search-result-item: title: Label Search Result Item description: Label Search Result Item type: object properties: id: type: integer node_id: type: string url: type: string format: uri name: type: string color: type: string default: type: boolean description: type: string nullable: true score: type: number text_matches: "$ref": "#/components/schemas/search-result-text-matches" required: - id - node_id - url - name - color - default - description - score repo-search-result-item: title: Repo Search Result Item description: Repo Search Result Item type: object properties: id: type: integer node_id: type: string name: type: string full_name: type: string owner: "$ref": "#/components/schemas/nullable-simple-user" private: type: boolean html_url: type: string format: uri description: type: string nullable: true fork: type: boolean url: type: string format: uri created_at: type: string format: date-time updated_at: type: string format: date-time pushed_at: type: string format: date-time homepage: type: string format: uri nullable: true size: type: integer stargazers_count: type: integer watchers_count: type: integer language: type: string nullable: true forks_count: type: integer open_issues_count: type: integer master_branch: type: string default_branch: type: string score: type: number forks_url: type: string format: uri keys_url: type: string collaborators_url: type: string teams_url: type: string format: uri hooks_url: type: string format: uri issue_events_url: type: string events_url: type: string format: uri assignees_url: type: string branches_url: type: string tags_url: type: string format: uri blobs_url: type: string git_tags_url: type: string git_refs_url: type: string trees_url: type: string statuses_url: type: string languages_url: type: string format: uri stargazers_url: type: string format: uri contributors_url: type: string format: uri subscribers_url: type: string format: uri subscription_url: type: string format: uri commits_url: type: string git_commits_url: type: string comments_url: type: string issue_comment_url: type: string contents_url: type: string compare_url: type: string merges_url: type: string format: uri archive_url: type: string downloads_url: type: string format: uri issues_url: type: string pulls_url: type: string milestones_url: type: string notifications_url: type: string labels_url: type: string releases_url: type: string deployments_url: type: string format: uri git_url: type: string ssh_url: type: string clone_url: type: string svn_url: type: string format: uri forks: type: integer open_issues: type: integer watchers: type: integer topics: type: array items: type: string mirror_url: type: string format: uri nullable: true has_issues: type: boolean has_projects: type: boolean has_pages: type: boolean has_wiki: type: boolean has_downloads: type: boolean has_discussions: type: boolean archived: type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' type: string license: "$ref": "#/components/schemas/nullable-license-simple" permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean required: - admin - pull - push text_matches: "$ref": "#/components/schemas/search-result-text-matches" temp_clone_token: type: string allow_merge_commit: type: boolean allow_squash_merge: type: boolean allow_rebase_merge: type: boolean allow_auto_merge: type: boolean delete_branch_on_merge: type: boolean allow_forking: type: boolean is_template: type: boolean web_commit_signoff_required: type: boolean example: false required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at - score topic-search-result-item: title: Topic Search Result Item description: Topic Search Result Item type: object properties: name: type: string display_name: type: string nullable: true short_description: type: string nullable: true description: type: string nullable: true created_by: type: string nullable: true released: type: string nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time featured: type: boolean curated: type: boolean score: type: number repository_count: type: integer nullable: true logo_url: type: string format: uri nullable: true text_matches: "$ref": "#/components/schemas/search-result-text-matches" related: type: array nullable: true items: type: object properties: topic_relation: type: object properties: id: type: integer name: type: string topic_id: type: integer relation_type: type: string aliases: type: array nullable: true items: type: object properties: topic_relation: type: object properties: id: type: integer name: type: string topic_id: type: integer relation_type: type: string required: - name - display_name - short_description - description - created_by - released - created_at - updated_at - featured - curated - score user-search-result-item: title: User Search Result Item description: User Search Result Item type: object properties: login: type: string id: type: integer format: int64 node_id: type: string avatar_url: type: string format: uri gravatar_id: type: string nullable: true url: type: string format: uri html_url: type: string format: uri followers_url: type: string format: uri subscriptions_url: type: string format: uri organizations_url: type: string format: uri repos_url: type: string format: uri received_events_url: type: string format: uri type: type: string score: type: number following_url: type: string gists_url: type: string starred_url: type: string events_url: type: string public_repos: type: integer public_gists: type: integer followers: type: integer following: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time name: type: string nullable: true bio: type: string nullable: true email: type: string format: email nullable: true location: type: string nullable: true site_admin: type: boolean hireable: type: boolean nullable: true text_matches: "$ref": "#/components/schemas/search-result-text-matches" blog: type: string nullable: true company: type: string nullable: true suspended_at: type: string format: date-time nullable: true user_view_type: type: string required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url - score private-user: title: Private User description: Private User type: object properties: login: type: string example: octocat id: type: integer format: int64 example: 1 user_view_type: type: string node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean name: type: string example: monalisa octocat nullable: true company: type: string example: GitHub nullable: true blog: type: string example: https://github.com/blog nullable: true location: type: string example: San Francisco nullable: true email: type: string format: email example: octocat@github.com nullable: true notification_email: type: string format: email example: octocat@github.com nullable: true hireable: type: boolean nullable: true bio: type: string example: There once was... nullable: true twitter_username: type: string example: monalisa nullable: true public_repos: type: integer example: 2 public_gists: type: integer example: 1 followers: type: integer example: 20 following: type: integer example: 0 created_at: type: string format: date-time example: '2008-01-14T04:33:35Z' updated_at: type: string format: date-time example: '2008-01-14T04:33:35Z' private_gists: type: integer example: 81 total_private_repos: type: integer example: 100 owned_private_repos: type: integer example: 100 disk_usage: type: integer example: 10000 collaborators: type: integer example: 8 two_factor_authentication: type: boolean example: true plan: type: object properties: collaborators: type: integer name: type: string space: type: integer private_repos: type: integer required: - collaborators - name - space - private_repos business_plus: type: boolean ldap_dn: type: string required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url - bio - blog - company - email - followers - following - hireable - location - name - public_gists - public_repos - created_at - updated_at - collaborators - disk_usage - owned_private_repos - private_gists - total_private_repos - two_factor_authentication codespaces-secret: title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object properties: name: description: The name of the secret example: SECRET_NAME type: string created_at: description: The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time updated_at: description: The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. type: string format: date-time visibility: description: The type of repositories in the organization that the secret is visible to enum: - all - private - selected type: string selected_repositories_url: description: The API URL at which the list of repositories this secret is visible to can be retrieved type: string format: uri example: https://api.github.com/user/secrets/SECRET_NAME/repositories required: - name - created_at - updated_at - visibility - selected_repositories_url codespaces-user-public-key: title: CodespacesUserPublicKey description: The public key used for setting user Codespaces' Secrets. type: object properties: key_id: description: The identifier for the key. type: string example: '1234567' key: description: The Base64 encoded public key. type: string example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= required: - key_id - key codespace-export-details: type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest properties: state: type: string description: State of the latest export nullable: true example: succeeded | failed | in_progress completed_at: description: Completion time of the last export operation type: string format: date-time nullable: true example: '2021-01-01T19:01:12Z' branch: type: string description: Name of the exported branch nullable: true example: codespace-monalisa-octocat-hello-world-g4wpq6h95q sha: type: string description: Git commit SHA of the exported branch nullable: true example: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: type: string description: Id for the export details example: latest export_url: type: string description: Url for fetching export details example: https://api.github.com/user/codespaces/:name/exports/latest html_url: type: string nullable: true description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch codespace-with-full-repository: type: object title: Codespace description: A codespace. properties: id: type: integer format: int64 example: 1 name: description: Automatically generated name of this codespace. type: string example: monalisa-octocat-hello-world-g4wpq6h95q display_name: description: Display name for this codespace. type: string example: bookish space pancake nullable: true environment_id: description: UUID identifying this codespace's environment. type: string example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 nullable: true owner: "$ref": "#/components/schemas/simple-user" billable_owner: "$ref": "#/components/schemas/simple-user" repository: "$ref": "#/components/schemas/full-repository" machine: "$ref": "#/components/schemas/nullable-codespace-machine" devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. type: string example: ".devcontainer/example/devcontainer.json" nullable: true prebuild: description: Whether the codespace was created from a prebuild. type: boolean example: false nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:01:12Z' last_used_at: description: Last known time this codespace was started. type: string format: date-time example: '2011-01-26T19:01:12Z' state: description: State of this codespace. enum: - Unknown - Created - Queued - Provisioning - Available - Awaiting - Unavailable - Deleted - Moved - Shutdown - Archived - Starting - ShuttingDown - Failed - Exporting - Updating - Rebuilding example: Available type: string url: description: API URL for this codespace. type: string format: uri git_status: description: Details about the codespace's git repository. type: object properties: ahead: description: The number of commits the local repository is ahead of the remote. type: integer example: 0 behind: description: The number of commits the local repository is behind the remote. type: integer example: 0 has_unpushed_changes: description: Whether the local repository has unpushed changes. type: boolean has_uncommitted_changes: description: Whether the local repository has uncommitted changes. type: boolean ref: description: The current branch (or SHA if in detached HEAD state) of the local repository. type: string example: main location: description: The initally assigned location of a new codespace. enum: - EastUs - SouthEastAsia - WestEurope - WestUs2 example: WestUs2 type: string idle_timeout_minutes: description: The number of minutes of inactivity after which this codespace will be automatically stopped. type: integer example: 60 nullable: true web_url: description: URL to access this codespace on the web. type: string format: uri machines_url: description: API URL to access available alternate machine types for this codespace. type: string format: uri start_url: description: API URL to start this codespace. type: string format: uri stop_url: description: API URL to stop this codespace. type: string format: uri publish_url: description: API URL to publish this codespace to a new repository. type: string format: uri nullable: true pulls_url: description: API URL for the Pull Request associated with this codespace, if any. type: string format: uri nullable: true recent_folders: type: array items: type: string runtime_constraints: type: object properties: allowed_port_privacy_settings: description: The privacy settings a user can select from when forwarding a port. type: array items: type: string nullable: true pending_operation: description: Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. type: boolean nullable: true pending_operation_disabled_reason: description: Text to show user when codespace is disabled by a pending operation type: string nullable: true idle_timeout_notice: description: Text to show user when codespace idle timeout minutes has been overriden by an organization policy type: string nullable: true retention_period_minutes: description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). type: integer example: 60 nullable: true retention_expires_at: description: When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" type: string format: date-time example: '2011-01-26T20:01:12Z' nullable: true required: - id - name - environment_id - owner - billable_owner - repository - machine - prebuild - created_at - updated_at - last_used_at - state - url - git_status - location - idle_timeout_minutes - web_url - machines_url - start_url - stop_url - pulls_url - recent_folders email: title: Email description: Email type: object properties: email: type: string format: email example: octocat@github.com primary: type: boolean example: true verified: type: boolean example: true visibility: type: string example: public nullable: true required: - email - primary - verified - visibility gpg-key: title: GPG Key description: A unique encryption key type: object properties: id: type: integer format: int64 example: 3 name: type: string example: Octocat's GPG Key nullable: true primary_key_id: type: integer nullable: true key_id: type: string example: 3262EFF25BA0D270 public_key: type: string example: xsBNBFayYZ... emails: type: array example: - email: octocat@users.noreply.github.com verified: true items: type: object properties: email: type: string verified: type: boolean subkeys: type: array example: - id: 4 primary_key_id: 3 key_id: 4A595D4C72EE49C7 public_key: zsBNBFayYZ... emails: [] can_sign: false can_encrypt_comms: true can_encrypt_storage: true can_certify: false created_at: '2016-03-24T11:31:04-06:00' expires_at: revoked: false items: type: object properties: id: type: integer format: int64 primary_key_id: type: integer key_id: type: string public_key: type: string emails: type: array items: type: object properties: email: type: string verified: type: boolean subkeys: type: array items: {} can_sign: type: boolean can_encrypt_comms: type: boolean can_encrypt_storage: type: boolean can_certify: type: boolean created_at: type: string expires_at: type: string nullable: true raw_key: type: string nullable: true revoked: type: boolean can_sign: type: boolean example: true can_encrypt_comms: type: boolean can_encrypt_storage: type: boolean can_certify: type: boolean example: true created_at: type: string format: date-time example: '2016-03-24T11:31:04-06:00' expires_at: type: string format: date-time nullable: true revoked: type: boolean example: true raw_key: type: string nullable: true required: - id - primary_key_id - key_id - raw_key - public_key - created_at - expires_at - can_sign - can_encrypt_comms - can_encrypt_storage - can_certify - emails - subkeys - revoked key: title: Key description: Key type: object properties: key: type: string id: type: integer format: int64 url: type: string title: type: string created_at: type: string format: date-time verified: type: boolean read_only: type: boolean last_used: nullable: true type: string format: date-time required: - key - id - url - title - created_at - verified - read_only marketplace-account: title: Marketplace Account type: object properties: url: type: string format: uri id: type: integer type: type: string node_id: type: string login: type: string email: type: string nullable: true format: email organization_billing_email: type: string nullable: true format: email required: - url - id - type - login user-marketplace-purchase: title: User Marketplace Purchase description: User Marketplace Purchase type: object properties: billing_cycle: type: string example: monthly next_billing_date: type: string format: date-time example: '2017-11-11T00:00:00Z' nullable: true unit_count: type: integer nullable: true on_free_trial: type: boolean example: true free_trial_ends_on: type: string format: date-time example: '2017-11-11T00:00:00Z' nullable: true updated_at: type: string format: date-time example: '2017-11-02T01:12:12Z' nullable: true account: "$ref": "#/components/schemas/marketplace-account" plan: "$ref": "#/components/schemas/marketplace-listing-plan" required: - billing_cycle - next_billing_date - unit_count - updated_at - on_free_trial - free_trial_ends_on - account - plan social-account: title: Social account description: Social media account type: object properties: provider: type: string example: linkedin url: type: string example: https://www.linkedin.com/company/github/ required: - provider - url ssh-signing-key: title: SSH Signing Key description: A public SSH key used to sign Git commits type: object properties: key: type: string id: type: integer title: type: string created_at: type: string format: date-time required: - key - id - title - created_at starred-repository: title: Starred Repository description: Starred Repository type: object properties: starred_at: type: string format: date-time repo: "$ref": "#/components/schemas/repository" required: - starred_at - repo hovercard: title: Hovercard description: Hovercard type: object properties: contexts: type: array items: type: object properties: message: type: string octicon: type: string required: - message - octicon required: - contexts key-simple: title: Key Simple description: Key Simple type: object properties: id: type: integer key: type: string created_at: type: string format: date-time last_used: nullable: true type: string format: date-time required: - key - id billing-premium-request-usage-report-user: type: object properties: timePeriod: type: object properties: year: type: integer description: The year for the usage report. month: type: integer description: The month for the usage report. day: type: integer description: The day for the usage report. required: - year user: type: string description: The unique identifier of the user. product: type: string description: The product for the usage report. model: type: string description: The model for the usage report. usageItems: type: array items: type: object properties: product: type: string description: Product name. sku: type: string description: SKU name. model: type: string description: Model name. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossQuantity: type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: type: number description: Net quantity of the usage line item. netAmount: type: number description: Net amount of the usage line item. required: - product - sku - model - unitType - pricePerUnit - grossQuantity - grossAmount - discountQuantity - discountAmount - netQuantity - netAmount required: - timePeriod - user - usageItems billing-usage-report-user: type: object properties: usageItems: type: array items: type: object properties: date: type: string description: Date of the usage line item. product: type: string description: Product name. sku: type: string description: SKU name. quantity: type: integer description: Quantity of the usage line item. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netAmount: type: number description: Net amount of the usage line item. repositoryName: type: string description: Name of the repository. required: - date - product - sku - quantity - unitType - pricePerUnit - grossAmount - discountAmount - netAmount billing-usage-summary-report-user: type: object properties: timePeriod: type: object properties: year: type: integer description: The year for the usage report. month: type: integer description: The month for the usage report. day: type: integer description: The day for the usage report. required: - year user: type: string description: The unique identifier of the user. repository: type: string description: The name of the repository for the usage report. product: type: string description: The product for the usage report. sku: type: string description: The SKU for the usage report. usageItems: type: array items: type: object properties: product: type: string description: Product name. sku: type: string description: SKU name. unitType: type: string description: Unit type of the usage line item. pricePerUnit: type: number description: Price per unit of the usage line item. grossQuantity: type: number description: Gross quantity of the usage line item. grossAmount: type: number description: Gross amount of the usage line item. discountQuantity: type: number description: Discount quantity of the usage line item. discountAmount: type: number description: Discount amount of the usage line item. netQuantity: type: number description: Net quantity of the usage line item. netAmount: type: number description: Net amount of the usage line item. required: - product - sku - unitType - pricePerUnit - grossQuantity - grossAmount - discountQuantity - discountAmount - netQuantity - netAmount required: - timePeriod - user - usageItems enterprise-webhooks: title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts)." type: object properties: description: description: A short description of the enterprise. type: string nullable: true html_url: type: string format: uri example: https://github.com/enterprises/octo-business website_url: description: The enterprise's website URL. type: string nullable: true format: uri id: description: Unique identifier of the enterprise example: 42 type: integer node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the enterprise. type: string example: Octo Business slug: description: The slug url identifier for the enterprise. type: string example: octo-business created_at: type: string nullable: true format: date-time example: '2019-01-26T19:01:12Z' updated_at: type: string nullable: true format: date-time example: '2019-01-26T19:14:43Z' avatar_url: type: string format: uri required: - id - node_id - name - slug - html_url - created_at - updated_at - avatar_url simple-installation: title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." type: object properties: id: description: The ID of the installation. type: integer example: 1 node_id: description: The global node ID of the installation. type: string example: MDQ6VXNlcjU4MzIzMQ== required: - id - node_id organization-simple-webhooks: title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization. type: object properties: login: type: string example: github id: type: integer example: 1 node_id: type: string example: MDEyOk9yZ2FuaXphdGlvbjE= url: type: string format: uri example: https://api.github.com/orgs/github repos_url: type: string format: uri example: https://api.github.com/orgs/github/repos events_url: type: string format: uri example: https://api.github.com/orgs/github/events hooks_url: type: string example: https://api.github.com/orgs/github/hooks issues_url: type: string example: https://api.github.com/orgs/github/issues members_url: type: string example: https://api.github.com/orgs/github/members{/member} public_members_url: type: string example: https://api.github.com/orgs/github/public_members{/member} avatar_url: type: string example: https://github.com/images/error/octocat_happy.gif description: type: string example: A great organization nullable: true required: - login - url - id - node_id - repos_url - events_url - hooks_url - issues_url - members_url - public_members_url - avatar_url - description repository-webhooks: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" organization: "$ref": "#/components/schemas/nullable-simple-user" forks: type: integer permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push owner: "$ref": "#/components/schemas/simple-user" private: description: Whether the repository is private or public. default: false type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string custom_properties: type: object description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true template_repository: nullable: true type: object properties: id: type: integer node_id: type: string name: type: string full_name: type: string owner: type: object properties: login: type: string id: type: integer node_id: type: string avatar_url: type: string gravatar_id: type: string url: type: string html_url: type: string followers_url: type: string following_url: type: string gists_url: type: string starred_url: type: string subscriptions_url: type: string organizations_url: type: string repos_url: type: string events_url: type: string received_events_url: type: string type: type: string site_admin: type: boolean private: type: boolean html_url: type: string description: type: string fork: type: boolean url: type: string archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string downloads_url: type: string events_url: type: string forks_url: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string git_url: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string notifications_url: type: string pulls_url: type: string releases_url: type: string ssh_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string clone_url: type: string mirror_url: type: string hooks_url: type: string svn_url: type: string homepage: type: string language: type: string forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: type: integer default_branch: type: string open_issues_count: type: integer is_template: type: boolean topics: type: array items: type: string has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_downloads: type: boolean archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string created_at: type: string updated_at: type: string permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean allow_rebase_merge: type: boolean temp_clone_token: type: string allow_squash_merge: type: boolean allow_auto_merge: type: boolean delete_branch_on_merge: type: boolean allow_update_branch: type: boolean use_squash_pr_title_as_default: type: boolean squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: type: boolean subscribers_count: type: integer network_count: type: integer temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_update_branch: description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. default: false type: boolean example: false use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo type: boolean web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean subscribers_count: type: integer network_count: type: integer open_issues: type: integer watchers: type: integer master_branch: type: string starred_at: type: string example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at webhooks_rule: title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. type: object properties: admin_enforced: type: boolean allow_deletions_enforcement_level: type: string enum: - 'off' - non_admins - everyone allow_force_pushes_enforcement_level: type: string enum: - 'off' - non_admins - everyone authorized_actor_names: type: array items: type: string authorized_actors_only: type: boolean authorized_dismissal_actors_only: type: boolean create_protected: type: boolean created_at: type: string format: date-time dismiss_stale_reviews_on_push: type: boolean id: type: integer ignore_approvals_from_contributors: type: boolean linear_history_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone lock_branch_enforcement_level: description: The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. type: string enum: - 'off' - non_admins - everyone lock_allows_fork_sync: description: Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. type: boolean merge_queue_enforcement_level: type: string enum: - 'off' - non_admins - everyone name: type: string pull_request_reviews_enforcement_level: type: string enum: - 'off' - non_admins - everyone repository_id: type: integer require_code_owner_review: type: boolean require_last_push_approval: description: Whether the most recent push must be approved by someone other than the person who pushed it type: boolean required_approving_review_count: type: integer required_conversation_resolution_level: type: string enum: - 'off' - non_admins - everyone required_deployments_enforcement_level: type: string enum: - 'off' - non_admins - everyone required_status_checks: type: array items: type: string required_status_checks_enforcement_level: type: string enum: - 'off' - non_admins - everyone signature_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone strict_required_status_checks_policy: type: boolean updated_at: type: string format: date-time required: - id - repository_id - name - created_at - updated_at - pull_request_reviews_enforcement_level - required_approving_review_count - dismiss_stale_reviews_on_push - require_code_owner_review - authorized_dismissal_actors_only - ignore_approvals_from_contributors - required_status_checks - required_status_checks_enforcement_level - strict_required_status_checks_policy - signature_requirement_enforcement_level - linear_history_requirement_enforcement_level - lock_branch_enforcement_level - admin_enforced - allow_force_pushes_enforcement_level - allow_deletions_enforcement_level - merge_queue_enforcement_level - required_deployments_enforcement_level - required_conversation_resolution_level - authorized_actors_only - authorized_actor_names exemption-request-push-ruleset-bypass: title: Push ruleset bypass exemption request data description: Push rules that are being requested to be bypassed. type: object properties: type: type: string description: The type of request enum: - push_ruleset_bypass data: type: array description: The data pertaining to the push rules that are being requested to be bypassed. items: type: object properties: ruleset_id: type: integer description: The ID of the ruleset for the rules that were violated ruleset_name: type: string description: The name of the ruleset for the rules that were violated total_violations: type: integer description: The number of violations rule_type: type: string description: The type of rule that was violated exemption-request-secret-scanning: title: Secret scanning push protection exemption request data description: Secret scanning push protections that are being requested to be bypassed. type: object properties: type: type: string description: The type of request enum: - secret_scanning data: type: array description: The data pertaining to the secret scanning push protections that are being requested to be bypassed. items: type: object properties: secret_type: type: string description: The type of secret that was detected locations: type: array description: The location data of the secret that was detected items: type: object properties: commit: type: string description: The commit SHA where the secret was detected branch: type: string description: The branch where the secret was detected path: type: string description: The path of the file where the secret was detected dismissal-request-secret-scanning: title: Secret scanning alert dismissal request data description: Secret scanning alerts that have dismissal requests. type: object properties: type: type: string description: The type of request enum: - secret_scanning_closure data: type: array description: The data related to the secret scanning alerts that have dismissal requests. items: type: object properties: reason: type: string description: The reason for the dismissal request enum: - fixed_later - false_positive - tests - revoked secret_type: type: string description: The type of secret that was detected alert_number: type: string description: The number of the alert that was detected dismissal-request-code-scanning: title: Code scanning alert dismissal request data description: Code scanning alerts that have dismissal requests. type: object properties: type: type: string description: The type of request enum: - code_scanning_alert_dismissal data: type: array description: The data related to the code scanning alerts that have dismissal requests. items: type: object properties: alert_number: type: string description: The number of the alert to be dismissed exemption-request-secret-scanning-metadata: title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. type: object properties: label: type: string description: The label for the secret type reason: type: string description: The reason for the exemption request enum: - fixed_later - false_positive - tests dismissal-request-secret-scanning-metadata: title: Secret scanning alert dismissal request metadata description: Metadata for a secret scanning alert dismissal request. type: object properties: alert_title: type: string description: The title of the secret alert reason: type: string description: The reason for the dismissal request enum: - fixed_later - false_positive - tests - revoked dismissal-request-code-scanning-metadata: title: Code scanning alert dismissal request metadata description: Metadata for a code scanning alert dismissal request. type: object properties: alert_title: type: string description: The title of the code scanning alert reason: type: string description: The reason for the dismissal request enum: - false positive - won't fix - used in tests exemption-response: title: Exemption response description: A response to an exemption request by a delegated bypasser. type: object properties: id: type: integer description: The ID of the exemption response. reviewer_id: type: integer description: The ID of the user who reviewed the exemption request. reviewer_login: type: string description: The login of the user who reviewed the exemption request. status: type: string description: The status of the exemption response. enum: - approved - rejected - dismissed reviewer_comment: type: string description: The comment the reviewer provided when responding to the exemption request. nullable: true created_at: type: string format: date-time description: The date and time the exemption request was created. exemption-request: title: Exemption Request description: A request from a user to be exempted from a set of rules. type: object properties: id: type: integer description: The ID of the exemption request. number: type: integer description: The number uniquely identifying the exemption request within it's repository. nullable: true repository_id: type: integer description: The ID of the repository the exemption request is for. requester_id: type: integer description: The ID of the user who requested the exemption. requester_login: type: string description: The login of the user who requested the exemption. request_type: type: string description: The type of request. enum: - push_ruleset_bypass - secret_scanning - secret_scanning_closure - code_scanning_alert_dismissal exemption_request_data: oneOf: - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" - "$ref": "#/components/schemas/exemption-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-code-scanning" resource_identifier: type: string description: The unique identifier for the request type of the exemption request. For example, a commit SHA. example: 827efc6d56897b048c772eb4087f854f46256132 status: type: string description: The status of the exemption request. enum: - pending - rejected - cancelled - completed requester_comment: type: string description: The comment the requester provided when creating the exemption request. nullable: true metadata: type: object description: Metadata about the exemption request. nullable: true anyOf: - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" expires_at: type: string format: date-time description: The date and time the exemption request will expire. created_at: type: string format: date-time description: The date and time the exemption request was created. responses: type: array description: The responses to the exemption request. nullable: true items: "$ref": "#/components/schemas/exemption-response" html_url: type: string description: The URL to view the exemption request in a browser. format: uri example: https://github.com/monalisa/smile/exemptions/1 simple-check-suite: description: A suite of checks performed on the code of a given code change type: object properties: after: example: d6fde92930d4715a2b49857d24b940956b26d2d3 type: string nullable: true app: "$ref": "#/components/schemas/integration" before: example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 type: string nullable: true conclusion: example: neutral type: string nullable: true enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required - stale - startup_failure created_at: type: string format: date-time head_branch: example: master type: string nullable: true head_sha: description: The SHA of the head commit that is being checked. example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' type: string id: example: 5 type: integer node_id: example: MDEwOkNoZWNrU3VpdGU1 type: string pull_requests: type: array items: "$ref": "#/components/schemas/pull-request-minimal" repository: "$ref": "#/components/schemas/minimal-repository" status: example: completed type: string enum: - queued - in_progress - completed - pending - waiting updated_at: type: string format: date-time url: example: https://api.github.com/repos/github/hello-world/check-suites/5 type: string check-run-with-simple-check-suite: title: CheckRun description: A check performed on the code of a given code change type: object properties: app: "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: example: '2018-05-04T01:14:52Z' type: string nullable: true format: date-time conclusion: example: neutral type: string nullable: true enum: - waiting - pending - startup_failure - stale - success - failure - neutral - cancelled - skipped - timed_out - action_required deployment: "$ref": "#/components/schemas/deployment-simple" details_url: example: https://example.com type: string external_id: example: '42' type: string head_sha: description: The SHA of the commit that is being checked. example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' type: string html_url: example: https://github.com/github/hello-world/runs/4 type: string id: description: The id of the check. example: 21 type: integer name: description: The name of the check. example: test-coverage type: string node_id: example: MDg6Q2hlY2tSdW40 type: string output: type: object properties: annotations_count: type: integer annotations_url: type: string format: uri summary: type: string nullable: true text: type: string nullable: true title: type: string nullable: true required: - title - summary - text - annotations_count - annotations_url pull_requests: type: array items: "$ref": "#/components/schemas/pull-request-minimal" started_at: example: '2018-05-04T01:14:52Z' type: string format: date-time status: description: The phase of the lifecycle that the check is currently in. example: queued type: string enum: - queued - in_progress - completed - pending url: example: https://api.github.com/repos/github/hello-world/check-runs/4 type: string required: - id - node_id - head_sha - name - url - html_url - details_url - status - conclusion - started_at - completed_at - external_id - check_suite - output - app - pull_requests webhooks_code_scanning_commit_oid: description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string webhooks_code_scanning_ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string webhooks_deploy_pusher_type: description: The pusher type for the event. Can be either `user` or a deploy key. type: string webhooks_ref_0: description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string webhooks_deploy_key: description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: added_by: type: string nullable: true created_at: type: string id: type: integer key: type: string last_used: type: string nullable: true read_only: type: boolean title: type: string url: type: string format: uri verified: type: boolean enabled: type: boolean required: - id - key - url - title - verified - created_at - read_only webhooks_workflow: title: Workflow type: object nullable: true properties: badge_url: type: string format: uri created_at: type: string format: date-time html_url: type: string format: uri id: type: integer name: type: string node_id: type: string path: type: string state: type: string updated_at: type: string format: date-time url: type: string format: uri required: - badge_url - created_at - html_url - id - name - node_id - path - state - updated_at - url webhooks_approver: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string webhooks_reviewers: type: array items: type: object properties: reviewer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id type: type: string enum: - User webhooks_workflow_job_run: type: object properties: conclusion: nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: nullable: true status: type: string updated_at: type: string required: - id - name - status - conclusion - html_url - created_at - updated_at - environment webhooks_user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id webhooks_answer: type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string child_comment_count: type: integer created_at: type: string format: date-time discussion_id: type: integer html_url: type: string id: type: integer node_id: type: string parent_id: nullable: true reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string updated_at: type: string format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - id - node_id - html_url - parent_id - child_comment_count - repository_url - discussion_id - author_association - user - created_at - updated_at - body discussion: title: Discussion description: A Discussion in a repository. type: object properties: active_lock_reason: type: string nullable: true answer_chosen_at: type: string nullable: true answer_chosen_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id answer_html_url: type: string nullable: true author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string category: type: object properties: created_at: type: string format: date-time description: type: string emoji: type: string id: type: integer is_answerable: type: boolean name: type: string node_id: type: string repository_id: type: integer slug: type: string updated_at: type: string required: - id - repository_id - emoji - name - description - created_at - updated_at - slug - is_answerable comments: type: integer created_at: type: string format: date-time html_url: type: string id: type: integer locked: type: boolean node_id: type: string number: type: integer reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string state: type: string description: |- The current state of the discussion. `converting` means that the discussion is being converted from an issue. `transferring` means that the discussion is being transferred from another repository. enum: - open - closed - locked - converting - transferring state_reason: description: The reason for the current state example: resolved type: string nullable: true enum: - resolved - outdated - duplicate - reopened timeline_url: type: string title: type: string updated_at: type: string format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id labels: type: array items: "$ref": "#/components/schemas/label" required: - repository_url - category - answer_html_url - answer_chosen_at - answer_chosen_by - html_url - id - node_id - number - title - user - state - state_reason - locked - comments - created_at - updated_at - author_association - active_lock_reason - body webhooks_comment: type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string child_comment_count: type: integer created_at: type: string discussion_id: type: integer html_url: type: string id: type: integer node_id: type: string parent_id: type: integer nullable: true reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string updated_at: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - id - node_id - html_url - parent_id - child_comment_count - repository_url - discussion_id - author_association - user - created_at - updated_at - body - reactions webhooks_label: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description webhooks_repositories: description: An array of repository objects that the installation can access. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private webhooks_repositories_added: description: An array of repository objects, which were added to the installation. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private webhooks_repository_selection: description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected webhooks_issue_comment: title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue comment type: string created_at: type: string format: date-time html_url: type: string format: uri id: description: Unique identifier of the issue comment type: integer format: int64 issue_url: type: string format: uri node_id: type: string performed_via_github_app: "$ref": "#/components/schemas/integration" reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket updated_at: type: string format: date-time url: description: URL for the issue comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id required: - url - html_url - issue_url - id - node_id - user - created_at - updated_at - author_association - performed_via_github_app - body - reactions webhooks_changes: description: The changes to the comment. type: object properties: body: type: object properties: from: description: The previous version of the body. type: string required: - from webhooks_issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - null assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" issue_field_values: type: array items: "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string type: "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions webhooks_milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at webhooks_issue_2: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - null assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" issue_field_values: type: array items: "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string type: "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions webhooks_user_mannequin: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id webhooks_marketplace_purchase: title: Marketplace Purchase type: object required: - account - billing_cycle - free_trial_ends_on - next_billing_date - on_free_trial - plan - unit_count properties: account: type: object required: - type - id - node_id - login - organization_billing_email properties: id: type: integer login: type: string node_id: type: string organization_billing_email: type: string nullable: true type: type: string billing_cycle: type: string free_trial_ends_on: type: string nullable: true next_billing_date: type: string nullable: true on_free_trial: type: boolean plan: type: object required: - id - name - description - monthly_price_in_cents - yearly_price_in_cents - price_model - has_free_trial - unit_name - bullets properties: bullets: type: array items: type: string nullable: true description: type: string has_free_trial: type: boolean id: type: integer monthly_price_in_cents: type: integer name: type: string price_model: type: string enum: - FREE - FLAT_RATE - PER_UNIT unit_name: type: string nullable: true yearly_price_in_cents: type: integer unit_count: type: integer webhooks_previous_marketplace_purchase: title: Marketplace Purchase type: object properties: account: type: object properties: id: type: integer login: type: string node_id: type: string organization_billing_email: type: string nullable: true type: type: string required: - type - id - node_id - login - organization_billing_email billing_cycle: type: string free_trial_ends_on: nullable: true next_billing_date: type: string nullable: true on_free_trial: type: boolean plan: type: object properties: bullets: type: array items: type: string description: type: string has_free_trial: type: boolean id: type: integer monthly_price_in_cents: type: integer name: type: string price_model: type: string enum: - FREE - FLAT_RATE - PER_UNIT unit_name: type: string nullable: true yearly_price_in_cents: type: integer required: - id - name - description - monthly_price_in_cents - yearly_price_in_cents - price_model - has_free_trial - unit_name - bullets unit_count: type: integer required: - account - billing_cycle - unit_count - on_free_trial - free_trial_ends_on - plan webhooks_team: title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret notification_setting: description: Whether team members will receive notifications when their team is @mentioned type: string enum: - notifications_enabled - notifications_disabled repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - name - id - node_id - slug - description - privacy - notification_setting - url - html_url - members_url - repositories_url - permission - type permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret notification_setting: type: string enum: - notifications_enabled - notifications_disabled repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - name - id merge-group: type: object title: Merge Group description: A group of pull requests that the merge queue has grouped together to be merged. properties: head_sha: description: The SHA of the merge group. type: string head_ref: description: The full ref of the merge group. type: string base_sha: description: The SHA of the merge group's parent commit. type: string base_ref: description: The full ref of the branch the merge group will be merged into. type: string head_commit: "$ref": "#/components/schemas/simple-commit" required: - head_sha - head_ref - base_sha - base_ref - head_commit nullable-repository-webhooks: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" organization: "$ref": "#/components/schemas/nullable-simple-user" forks: type: integer permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push owner: "$ref": "#/components/schemas/simple-user" private: description: Whether the repository is private or public. default: false type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string custom_properties: type: object description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true template_repository: nullable: true type: object properties: id: type: integer node_id: type: string name: type: string full_name: type: string owner: type: object properties: login: type: string id: type: integer node_id: type: string avatar_url: type: string gravatar_id: type: string url: type: string html_url: type: string followers_url: type: string following_url: type: string gists_url: type: string starred_url: type: string subscriptions_url: type: string organizations_url: type: string repos_url: type: string events_url: type: string received_events_url: type: string type: type: string site_admin: type: boolean private: type: boolean html_url: type: string description: type: string fork: type: boolean url: type: string archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string downloads_url: type: string events_url: type: string forks_url: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string git_url: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string notifications_url: type: string pulls_url: type: string releases_url: type: string ssh_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string clone_url: type: string mirror_url: type: string hooks_url: type: string svn_url: type: string homepage: type: string language: type: string forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: type: integer default_branch: type: string open_issues_count: type: integer is_template: type: boolean topics: type: array items: type: string has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_downloads: type: boolean archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string created_at: type: string updated_at: type: string permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean allow_rebase_merge: type: boolean temp_clone_token: type: string allow_squash_merge: type: boolean allow_auto_merge: type: boolean delete_branch_on_merge: type: boolean allow_update_branch: type: boolean use_squash_pr_title_as_default: type: boolean squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: type: boolean subscribers_count: type: integer network_count: type: integer temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_update_branch: description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. default: false type: boolean example: false use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo type: boolean web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean subscribers_count: type: integer network_count: type: integer open_issues: type: integer watchers: type: integer master_branch: type: string starred_at: type: string example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at nullable: true webhooks_milestone_3: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at webhooks_membership: title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. type: object properties: organization_url: type: string format: uri role: type: string direct_membership: type: boolean description: Whether the user has direct membership in the organization. example: true enterprise_teams_providing_indirect_membership: type: array description: |- The slugs of the enterprise teams providing the user with indirect membership in the organization. A limit of 100 enterprise team slugs is returned. maxItems: 100 items: type: string example: - ent:team-one - ent:team-two state: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - url - state - role - organization_url - user personal-access-token-request: title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object properties: id: type: integer description: Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. owner: "$ref": "#/components/schemas/simple-user" permissions_added: type: object description: New requested permissions, categorized by type of permission. properties: organization: type: object additionalProperties: type: string repository: type: object additionalProperties: type: string other: type: object additionalProperties: type: string permissions_upgraded: type: object description: Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. properties: organization: type: object additionalProperties: type: string repository: type: object additionalProperties: type: string other: type: object additionalProperties: type: string permissions_result: type: object description: Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. properties: organization: type: object additionalProperties: type: string repository: type: object additionalProperties: type: string other: type: object additionalProperties: type: string repository_selection: type: string description: Type of repository selection requested. enum: - none - all - subset repository_count: description: The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. type: integer nullable: true repositories: type: array description: An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private nullable: true created_at: type: string description: Date and time when the request for access was created. token_id: type: integer description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. token_name: type: string description: The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. token_expired: type: boolean description: Whether the associated fine-grained personal access token has expired. token_expires_at: type: string description: Date and time when the associated fine-grained personal access token expires. nullable: true token_last_used_at: type: string description: Date and time when the associated fine-grained personal access token was last used for authentication. nullable: true required: - id - owner - permissions_added - permissions_upgraded - permissions_result - repository_selection - repository_count - repositories - created_at - token_id - token_name - token_expired - token_expires_at - token_last_used_at webhooks_project_card: title: Project Card type: object properties: after_id: type: integer nullable: true archived: description: Whether or not the card is archived type: boolean column_id: type: integer column_url: type: string format: uri content_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id id: description: The project card's ID type: integer node_id: type: string note: type: string nullable: true project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - column_url - column_id - id - node_id - note - archived - creator - created_at - updated_at webhooks_project: title: Project type: object properties: body: description: Body of the project type: string nullable: true columns_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id html_url: type: string format: uri id: type: integer name: description: Name of the project type: string node_id: type: string number: type: integer owner_url: type: string format: uri state: description: State of the project; either 'open' or 'closed' type: string enum: - open - closed updated_at: type: string format: date-time url: type: string format: uri required: - owner_url - url - html_url - columns_url - id - node_id - name - body - number - state - creator - created_at - updated_at webhooks_project_column: title: Project Column type: object properties: after_id: type: integer nullable: true cards_url: type: string format: uri created_at: type: string format: date-time id: description: The unique identifier of the project column type: integer name: description: Name of the project column type: string node_id: type: string project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - cards_url - id - node_id - name - created_at - updated_at webhooks_project_changes: type: object properties: archived_at: type: object properties: from: type: string nullable: true format: date-time to: type: string nullable: true format: date-time projects-v2-item: title: Projects v2 Item description: An item belonging to a project type: object properties: id: type: number description: The unique identifier of the project item. node_id: type: string description: The node ID of the project item. project_node_id: type: string description: The node ID of the project that contains this item. content_node_id: type: string description: The node ID of the content represented by this item. content_type: "$ref": "#/components/schemas/projects-v2-item-content-type" creator: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the item was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the item was last updated. archived_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true description: The time when the item was archived. required: - id - content_node_id - content_type - created_at - updated_at - archived_at projects-v2-single-select-option: title: Projects v2 Single Select Option description: An option for a single select field type: object properties: id: type: string description: The unique identifier of the option. name: type: string description: The display name of the option. color: type: string nullable: true description: The color associated with the option. description: type: string nullable: true description: A short description of the option. required: - id - name projects-v2-iteration-setting: title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object properties: id: type: string description: The unique identifier of the iteration setting. title: type: string description: The iteration title. title_html: type: string description: The iteration title, rendered as HTML. duration: type: number nullable: true description: The duration of the iteration in days. start_date: type: string nullable: true description: The start date of the iteration. completed: type: boolean description: Whether the iteration has been completed. required: - id - title projects-v2-status-update: title: Projects v2 Status Update description: An status update belonging to a project type: object properties: id: type: number description: The unique identifier of the status update. node_id: type: string description: The node ID of the status update. project_node_id: type: string description: The node ID of the project that this status update belongs to. creator: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the status update was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' description: The time when the status update was last updated. status: type: string enum: - INACTIVE - ON_TRACK - AT_RISK - OFF_TRACK - COMPLETE nullable: true description: The current status. start_date: type: string format: date example: '2022-04-28' description: The start date of the period covered by the update. target_date: type: string format: date example: '2022-04-28' description: The target date associated with the update. body: description: Body of the status update example: The project is off to a great start! type: string nullable: true required: - id - node_id - created_at - updated_at webhooks_number: description: The pull request number. type: integer pull-request-webhook: allOf: - "$ref": "#/components/schemas/pull-request" - type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_update_branch: description: Whether to allow updating the pull request's branch. type: boolean delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged. type: boolean default: false merge_commit_message: description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). type: string enum: - PR_TITLE - MERGE_MESSAGE squash_merge_commit_message: description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_title: description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** type: boolean default: false webhooks_pull_request_5: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - null additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer format: int64 is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_title: description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull request title as default. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer format: int64 is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: description: |- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_title: description: |- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull request title as default. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft webhooks_review_comment: title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string format: date-time diff_hunk: description: The diff of the line that the comment refers to. type: string html_url: description: HTML URL for the pull request review comment. type: string format: uri id: description: The ID of the pull request review comment. type: integer in_reply_to_id: description: The comment ID to reply to. type: integer line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the pull request review comment. type: string original_commit_id: description: The SHA of the original commit to which the comment applies. type: string original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer original_position: description: The index of the original line in the diff to which the comment applies. type: integer original_start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true path: description: The relative path of the file to which the comment applies. type: string position: description: The line index in the diff to which the comment applies. type: integer nullable: true pull_request_review_id: description: The ID of the pull request review to which the comment belongs. type: integer nullable: true pull_request_url: description: URL for the pull request that the review comment belongs to. type: string format: uri reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket side: description: The side of the first line of the range for a multi-line comment. type: string enum: - LEFT - RIGHT start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true start_side: description: The side of the first line of the range for a multi-line comment. type: string nullable: true enum: - LEFT - RIGHT - null default: RIGHT subject_type: description: The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file updated_at: type: string format: date-time url: description: URL for the pull request review comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - url - pull_request_review_id - id - node_id - diff_hunk - path - position - original_position - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links - start_line - original_start_line - original_line - line - start_side - side - reactions webhooks_review: description: The review that was affected. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href required: - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the review. type: string nullable: true commit_id: description: A commit SHA for the review. type: string html_url: type: string format: uri id: description: Unique identifier of the review type: integer node_id: type: string pull_request_url: type: string format: uri state: type: string submitted_at: type: string nullable: true format: date-time updated_at: type: string nullable: true format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - id - node_id - user - body - commit_id - submitted_at - state - html_url - pull_request_url - author_association - _links webhooks_nullable_string: type: string nullable: true webhooks_release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer digest: type: string nullable: true state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - digest - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time updated_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer immutable: description: Whether or not the release is immutable. type: boolean name: type: string nullable: true node_id: type: string prerelease: description: Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - immutable - created_at - published_at - assets - tarball_url - updated_at - zipball_url - body webhooks_release_1: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. type: object required: - assets - assets_url - author - body - created_at - draft - html_url - id - name - node_id - prerelease - immutable - published_at - tag_name - tarball_url - target_commitish - updated_at - upload_url - url - zipball_url properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - digest - download_count - created_at - updated_at nullable: true properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer digest: type: string nullable: true state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true required: - login - id properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri url: type: string format: uri assets_url: type: string format: uri author: title: User type: object nullable: true required: - login - id properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer immutable: description: Whether or not the release is immutable. type: boolean name: type: string nullable: true node_id: type: string prerelease: description: Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: Specifies the commitish value that determines where the Git tag is created from. type: string updated_at: type: string nullable: true format: date-time upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri webhooks_alert: title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object required: - affected_package_name - affected_range - created_at - external_identifier - external_reference - ghsa_id - id - node_id - number - severity - state properties: affected_package_name: type: string affected_range: type: string created_at: type: string dismiss_reason: type: string dismissed_at: type: string dismisser: title: User type: object nullable: true required: - login - id properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri external_identifier: type: string external_reference: type: string nullable: true format: uri fix_reason: type: string fixed_at: type: string format: date-time fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - open secret-scanning-alert-resolution-webhook: type: string description: The reason for resolving the alert. nullable: true enum: - false_positive - wont_fix - revoked - used_in_tests - pattern_deleted - pattern_edited secret-scanning-alert-webhook: type: object properties: number: "$ref": "#/components/schemas/alert-number" created_at: "$ref": "#/components/schemas/alert-created-at" updated_at: "$ref": "#/components/schemas/nullable-alert-updated-at" url: "$ref": "#/components/schemas/alert-url" html_url: "$ref": "#/components/schemas/alert-html-url" locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. resolution: "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook" resolved_at: type: string format: date-time description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true resolved_by: "$ref": "#/components/schemas/nullable-simple-user" resolution_comment: type: string description: An optional comment to resolve an alert. nullable: true secret_type: type: string description: The type of secret that secret scanning detected. secret_type_display_name: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." validity: type: string description: The token status as of the latest validity check. enum: - active - inactive - unknown push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected secret. nullable: true push_protection_bypassed_by: "$ref": "#/components/schemas/nullable-simple-user" push_protection_bypassed_at: type: string format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true push_protection_bypass_request_reviewer: "$ref": "#/components/schemas/nullable-simple-user" push_protection_bypass_request_reviewer_comment: type: string description: An optional comment when reviewing a push protection bypass. nullable: true push_protection_bypass_request_comment: type: string description: An optional comment when requesting a push protection bypass. nullable: true push_protection_bypass_request_html_url: type: string format: uri description: The URL to a push protection bypass request. nullable: true publicly_leaked: type: boolean description: Whether the detected secret was publicly leaked. nullable: true multi_repo: type: boolean description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true assigned_to: "$ref": "#/components/schemas/nullable-simple-user" webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. type: object properties: cvss: type: object properties: score: type: number vector_string: type: string nullable: true required: - vector_string - score cvss_severities: "$ref": "#/components/schemas/cvss-severities" cwes: type: array items: type: object properties: cwe_id: type: string name: type: string required: - cwe_id - name description: type: string ghsa_id: type: string identifiers: type: array items: type: object properties: type: type: string value: type: string required: - value - type published_at: type: string references: type: array items: type: object properties: url: type: string format: uri required: - url severity: type: string summary: type: string updated_at: type: string vulnerabilities: type: array items: type: object properties: first_patched_version: type: object nullable: true properties: identifier: type: string required: - identifier package: type: object properties: ecosystem: type: string name: type: string required: - ecosystem - name severity: type: string vulnerable_version_range: type: string required: - package - severity - vulnerable_version_range - first_patched_version withdrawn_at: type: string nullable: true required: - cvss - cwes - ghsa_id - summary - description - severity - identifiers - references - published_at - updated_at - withdrawn_at - vulnerabilities webhooks_sponsorship: type: object properties: created_at: type: string maintainer: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string node_id: type: string privacy_level: type: string sponsor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id sponsorable: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id tier: title: Sponsorship Tier description: The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - node_id - created_at - sponsorable - sponsor - privacy_level - tier webhooks_effective_date: description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string webhooks_changes_8: type: object properties: tier: type: object properties: from: title: Sponsorship Tier description: The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - from required: - tier webhooks_team_1: title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret notification_setting: description: Whether team members will receive notifications when their team is @mentioned type: string enum: - notifications_enabled - notifications_disabled repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - name - id - node_id - slug - description - privacy - notification_setting - url - html_url - members_url - repositories_url - permission - type permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret notification_setting: description: Whether team members will receive notifications when their team is @mentioned type: string enum: - notifications_enabled - notifications_disabled repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri type: description: The ownership type of the team type: string enum: - enterprise - organization organization_id: type: integer description: Unique identifier of the organization to which this team belongs example: 37 enterprise_id: type: integer description: Unique identifier of the enterprise to which this team belongs example: 42 required: - name - id webhook-branch-protection-configuration-disabled: title: branch protection configuration disabled event type: object properties: action: type: string enum: - disabled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - repository - sender webhook-branch-protection-configuration-enabled: title: branch protection configuration enabled event type: object properties: action: type: string enum: - enabled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - repository - sender webhook-branch-protection-rule-created: title: branch protection rule created event type: object properties: action: type: string enum: - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" rule: "$ref": "#/components/schemas/webhooks_rule" sender: "$ref": "#/components/schemas/simple-user" required: - action - rule - repository - sender webhook-branch-protection-rule-deleted: title: branch protection rule deleted event type: object properties: action: type: string enum: - deleted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" rule: "$ref": "#/components/schemas/webhooks_rule" sender: "$ref": "#/components/schemas/simple-user" required: - action - rule - repository - sender webhook-branch-protection-rule-edited: title: branch protection rule edited event type: object properties: action: type: string enum: - edited changes: description: If the action was `edited`, the changes to the rule. type: object properties: admin_enforced: type: object properties: from: type: boolean nullable: true required: - from authorized_actor_names: type: object properties: from: type: array items: type: string required: - from authorized_actors_only: type: object properties: from: type: boolean nullable: true required: - from authorized_dismissal_actors_only: type: object properties: from: type: boolean nullable: true required: - from linear_history_requirement_enforcement_level: type: object properties: from: type: string enum: - 'off' - non_admins - everyone required: - from lock_branch_enforcement_level: type: object properties: from: type: string enum: - 'off' - non_admins - everyone required: - from lock_allows_fork_sync: type: object properties: from: type: boolean nullable: true required: - from pull_request_reviews_enforcement_level: type: object properties: from: type: string enum: - 'off' - non_admins - everyone required: - from require_last_push_approval: type: object properties: from: type: boolean nullable: true required: - from required_status_checks: type: object properties: from: type: array items: type: string required: - from required_status_checks_enforcement_level: type: object properties: from: type: string enum: - 'off' - non_admins - everyone required: - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" rule: "$ref": "#/components/schemas/webhooks_rule" sender: "$ref": "#/components/schemas/simple-user" required: - action - rule - repository - sender webhook-exemption-request-cancelled: title: Exemption request cancellation event type: object properties: action: type: string enum: - cancelled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" exemption_request: "$ref": "#/components/schemas/exemption-request" sender: "$ref": "#/components/schemas/simple-user" required: - action - exemption_request - sender webhook-exemption-request-completed: title: Exemption request completed event type: object properties: action: type: string enum: - completed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" exemption_request: "$ref": "#/components/schemas/exemption-request" sender: "$ref": "#/components/schemas/simple-user" required: - action - exemption_request - sender webhook-exemption-request-created: title: Exemption request created event type: object properties: action: type: string enum: - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" exemption_request: "$ref": "#/components/schemas/exemption-request" sender: "$ref": "#/components/schemas/simple-user" required: - action - exemption_request - sender webhook-exemption-request-response-dismissed: title: Exemption response dismissed event type: object properties: action: type: string enum: - response_dismissed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" exemption_request: "$ref": "#/components/schemas/exemption-request" exemption_response: "$ref": "#/components/schemas/exemption-response" sender: "$ref": "#/components/schemas/simple-user" required: - action - exemption_request - exemption_response - sender webhook-exemption-request-response-submitted: title: Exemption response submitted event type: object properties: action: type: string enum: - response_submitted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" exemption_request: "$ref": "#/components/schemas/exemption-request" exemption_response: "$ref": "#/components/schemas/exemption-response" sender: "$ref": "#/components/schemas/simple-user" required: - action - exemption_request - exemption_response - sender webhook-check-run-completed: title: Check Run Completed Event type: object properties: action: type: string enum: - completed check_run: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - check_run - repository - sender webhook-check-run-completed-form-encoded: title: Check Run Completed Event description: The check_run.completed webhook encoded with URL encoding type: object properties: payload: description: A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. type: string required: - payload webhook-check-run-created: title: Check Run Created Event type: object properties: action: type: string enum: - created check_run: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - check_run - repository - sender webhook-check-run-created-form-encoded: title: Check Run Created Event description: The check_run.created webhook encoded with URL encoding type: object properties: payload: description: A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. type: string required: - payload webhook-check-run-requested-action: title: Check Run Requested Action Event type: object properties: action: type: string enum: - requested_action check_run: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" requested_action: description: The action requested by the user. type: object properties: identifier: description: The integrator reference of the action requested by the user. type: string sender: "$ref": "#/components/schemas/simple-user" required: - action - check_run - repository - sender webhook-check-run-requested-action-form-encoded: title: Check Run Requested Action Event description: The check_run.requested_action webhook encoded with URL encoding type: object properties: payload: description: A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. type: string required: - payload webhook-check-run-rerequested: title: Check Run Re-Requested Event type: object properties: action: type: string enum: - rerequested check_run: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - check_run - repository - sender webhook-check-run-rerequested-form-encoded: title: Check Run Re-Requested Event description: The check_run.rerequested webhook encoded with URL encoding type: object properties: payload: description: A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. type: string required: - payload webhook-check-suite-completed: title: check_suite completed event type: object properties: action: type: string enum: - completed check_suite: description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). type: object properties: after: type: string nullable: true app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - merge_group - pull_request_review_thread - workflow_job - merge_queue_entry - security_and_analysis - projects_v2_item - secret_scanning_alert_location external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true client_id: description: The client ID of the GitHub app type: string nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at before: type: string nullable: true check_runs_url: type: string format: uri conclusion: description: The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null - skipped - startup_failure created_at: type: string format: date-time head_branch: description: The head branch name the changes are on. type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_sha: description: The SHA of the head commit that is being checked. type: string id: type: integer latest_check_runs_count: type: integer node_id: type: string pull_requests: description: An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base rerequestable: type: boolean runs_rerequestable: type: boolean status: description: The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. type: string nullable: true enum: - requested - in_progress - completed - queued - null - pending updated_at: type: string format: date-time url: description: URL that points to the check suite API resource. type: string format: uri required: - id - node_id - head_branch - head_sha - status - conclusion - url - before - after - pull_requests - app - created_at - updated_at - latest_check_runs_count - check_runs_url - head_commit enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - check_suite - repository - sender webhook-check-suite-requested: title: check_suite requested event type: object properties: action: type: string enum: - requested check_suite: description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). type: object properties: after: type: string nullable: true app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - workflow_job - merge_queue_entry - security_and_analysis - secret_scanning_alert_location - projects_v2_item - merge_group - repository_import external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true client_id: description: Client ID of the GitHub app type: string nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write attestations: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write merge_queues: type: string enum: - read - write metadata: type: string enum: - read - write models: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at before: type: string nullable: true check_runs_url: type: string format: uri conclusion: description: The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null - skipped created_at: type: string format: date-time head_branch: description: The head branch name the changes are on. type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_sha: description: The SHA of the head commit that is being checked. type: string id: type: integer latest_check_runs_count: type: integer node_id: type: string pull_requests: description: An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base rerequestable: type: boolean runs_rerequestable: type: boolean status: description: The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. type: string nullable: true enum: - requested - in_progress - completed - queued - null updated_at: type: string format: date-time url: description: URL that points to the check suite API resource. type: string format: uri required: - id - node_id - head_branch - head_sha - status - conclusion - url - before - after - pull_requests - app - created_at - updated_at - latest_check_runs_count - check_runs_url - head_commit enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - check_suite - repository - sender webhook-check-suite-rerequested: title: check_suite rerequested event type: object properties: action: type: string enum: - rerequested check_suite: description: The [check_suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite). type: object properties: after: type: string nullable: true app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - merge_queue_entry - workflow_job external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true client_id: description: The Client ID for the GitHub app type: string nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write attestations: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write merge_queues: type: string enum: - read - write metadata: type: string enum: - read - write models: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at before: type: string nullable: true check_runs_url: type: string format: uri conclusion: description: The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null created_at: type: string format: date-time head_branch: description: The head branch name the changes are on. type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_sha: description: The SHA of the head commit that is being checked. type: string id: type: integer latest_check_runs_count: type: integer node_id: type: string pull_requests: description: An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base rerequestable: type: boolean runs_rerequestable: type: boolean status: description: The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. type: string nullable: true enum: - requested - in_progress - completed - queued - null updated_at: type: string format: date-time url: description: URL that points to the check suite API resource. type: string format: uri required: - id - node_id - head_branch - head_sha - status - conclusion - url - before - after - pull_requests - app - created_at - updated_at - latest_check_runs_count - check_runs_url - head_commit enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - check_suite - repository - sender webhook-code-scanning-alert-appeared-in-branch: title: code_scanning_alert appeared_in_branch event type: object properties: action: type: string enum: - appeared_in_branch alert: description: The code scanning alert involved in the event. type: object properties: assignees: type: array items: "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' type: string format: date-time dismissed_at: description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' type: string nullable: true format: date-time dismissed_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: string nullable: true enum: - false positive - won't fix - used in tests - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string id: description: A unique identifier for the rule used to detect the alert. type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - null required: - id - severity - description state: description: State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. nullable: true type: string enum: - open - dismissed - fixed tool: type: object properties: name: description: The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" ref: "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-closed-by-user: title: code_scanning_alert closed_by_user event type: object properties: action: type: string enum: - closed_by_user alert: description: The code scanning alert involved in the event. type: object properties: assignees: type: array items: "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' type: string format: date-time dismissed_at: description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' type: string format: date-time dismissed_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: string nullable: true enum: - false positive - won't fix - used in tests - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - null tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. type: string enum: - dismissed - fixed tool: type: object properties: guid: type: string nullable: true name: description: The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri dismissal_approved_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" ref: "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-created: title: code_scanning_alert created event type: object properties: action: type: string enum: - created alert: description: The code scanning alert involved in the event. type: object properties: created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' type: string nullable: true format: date-time dismissed_at: description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true dismissed_by: nullable: true dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in tests`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri instances_url: type: string most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - null tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. type: string nullable: true enum: - open - dismissed tool: type: object nullable: true properties: guid: type: string nullable: true name: description: The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version updated_at: type: string nullable: true url: type: string format: uri dismissal_approved_by: nullable: true assignees: type: array items: "$ref": "#/components/schemas/simple-user" required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" ref: "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-fixed: title: code_scanning_alert fixed event type: object properties: action: type: string enum: - fixed alert: description: The code scanning alert involved in the event. type: object properties: assignees: type: array items: "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' type: string format: date-time dismissed_at: description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' type: string nullable: true format: date-time dismissed_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: string nullable: true enum: - false positive - won't fix - used in tests - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri instances_url: type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - null tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. nullable: true type: string enum: - fixed tool: type: object properties: guid: type: string nullable: true name: description: The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" ref: "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-reopened: title: code_scanning_alert reopened event type: object properties: action: type: string enum: - reopened alert: description: The code scanning alert involved in the event. type: object nullable: true properties: assignees: type: array items: "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' type: string format: date-time dismissed_at: description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' type: string nullable: true dismissed_by: type: object nullable: true dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in tests`.' type: string nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - null tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. nullable: true type: string enum: - open - dismissed - fixed tool: type: object properties: guid: type: string nullable: true name: description: The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-reopened-by-user: title: code_scanning_alert reopened_by_user event type: object properties: action: type: string enum: - reopened_by_user alert: description: The code scanning alert involved in the event. type: object properties: assignees: type: array items: "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' type: string format: date-time dismissed_at: description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true dismissed_by: nullable: true dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in tests`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string id: description: A unique identifier for the rule used to detect the alert. type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - null required: - id - severity - description state: description: State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. nullable: true type: string enum: - open - fixed tool: type: object properties: name: description: The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" ref: "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - ref - commit_oid - repository - sender webhook-commit-comment-created: title: commit_comment created event type: object properties: action: description: The action performed. Can be `created`. type: string enum: - created comment: description: The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string html_url: type: string format: uri id: description: The ID of the commit comment. type: integer line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the commit comment. type: string path: description: The relative path of the file to which the comment applies. type: string nullable: true position: description: The line index in the diff to which the comment applies. type: integer nullable: true reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - url - html_url - id - node_id - user - position - line - path - commit_id - created_at - updated_at - author_association - body enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - comment - repository - sender webhook-create: title: create event type: object properties: description: description: The repository's current description. type: string nullable: true enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" master_branch: description: The name of the repository's default branch (usually `main`). type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" pusher_type: "$ref": "#/components/schemas/webhooks_deploy_pusher_type" ref: "$ref": "#/components/schemas/webhooks_ref_0" ref_type: description: The type of Git ref object created in the repository. type: string enum: - tag - branch repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - ref - ref_type - master_branch - description - pusher_type - repository - sender webhook-custom-property-created: title: custom property created event type: object properties: action: type: string enum: - created definition: "$ref": "#/components/schemas/custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - definition webhook-custom-property-deleted: title: custom property deleted event type: object properties: action: type: string enum: - deleted definition: type: object properties: property_name: type: string description: The name of the property that was deleted. required: - property_name enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - definition webhook-custom-property-promoted-to-enterprise: title: custom property promoted to business event type: object properties: action: type: string enum: - promote_to_enterprise definition: "$ref": "#/components/schemas/custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - definition webhook-custom-property-updated: title: custom property updated event type: object properties: action: type: string enum: - updated definition: "$ref": "#/components/schemas/custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - definition webhook-custom-property-values-updated: title: Custom property values updated event type: object properties: action: type: string enum: - updated enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" repository: "$ref": "#/components/schemas/repository-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" sender: "$ref": "#/components/schemas/simple-user" new_property_values: type: array description: The new custom property values for the repository. items: "$ref": "#/components/schemas/custom-property-value" old_property_values: type: array description: The old custom property values for the repository. items: "$ref": "#/components/schemas/custom-property-value" required: - action - repository - organization - new_property_values - old_property_values webhook-delete: title: delete event type: object properties: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pusher_type: "$ref": "#/components/schemas/webhooks_deploy_pusher_type" ref: "$ref": "#/components/schemas/webhooks_ref_0" ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - ref - ref_type - pusher_type - repository - sender webhook-dependabot-alert-auto-dismissed: title: Dependabot alert auto-dismissed event type: object properties: action: type: string enum: - auto_dismissed alert: "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - repository - sender webhook-dependabot-alert-auto-reopened: title: Dependabot alert auto-reopened event type: object properties: action: type: string enum: - auto_reopened alert: "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - repository - sender webhook-dependabot-alert-created: title: Dependabot alert created event type: object properties: action: type: string enum: - created alert: "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - repository - sender webhook-dependabot-alert-dismissed: title: Dependabot alert dismissed event type: object properties: action: type: string enum: - dismissed alert: "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - repository - sender webhook-dependabot-alert-fixed: title: Dependabot alert fixed event type: object properties: action: type: string enum: - fixed alert: "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - repository - sender webhook-dependabot-alert-reintroduced: title: Dependabot alert reintroduced event type: object properties: action: type: string enum: - reintroduced alert: "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - repository - sender webhook-dependabot-alert-reopened: title: Dependabot alert reopened event type: object properties: action: type: string enum: - reopened alert: "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - alert - repository - sender webhook-deploy-key-created: title: deploy_key created event type: object properties: action: type: string enum: - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" key: "$ref": "#/components/schemas/webhooks_deploy_key" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - key - repository - sender webhook-deploy-key-deleted: title: deploy_key deleted event type: object properties: action: type: string enum: - deleted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" key: "$ref": "#/components/schemas/webhooks_deploy_key" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - key - repository - sender webhook-deployment-created: title: deployment created event type: object properties: action: type: string enum: - created deployment: title: Deployment description: The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments). type: object properties: created_at: type: string creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true environment: type: string id: type: integer node_id: type: string original_environment: type: string payload: oneOf: - type: object - type: string performed_via_github_app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - workflow_job - pull_request_review_thread - merge_queue_entry - secret_scanning_alert_location - merge_group external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at production_environment: type: boolean ref: type: string repository_url: type: string format: uri sha: type: string statuses_url: type: string format: uri task: type: string transient_environment: type: boolean updated_at: type: string url: type: string format: uri required: - url - id - node_id - sha - ref - task - payload - original_environment - environment - description - creator - created_at - updated_at - statuses_url - repository_url enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null created_at: type: string format: date-time display_title: type: string event: type: string head_branch: type: string head_commit: nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - run_attempt - run_started_at - display_title required: - action - deployment - workflow - workflow_run - repository - sender webhook-deployment-protection-rule-requested: title: deployment protection rule requested event type: object properties: action: type: string enum: - requested environment: description: The name of the environment that has the deployment protection rule. type: string event: description: The event that triggered the deployment protection rule. type: string deployment_callback_url: description: The URL to review the deployment protection rule. type: string format: uri deployment: "$ref": "#/components/schemas/deployment" pull_requests: type: array items: "$ref": "#/components/schemas/pull-request" repository: "$ref": "#/components/schemas/repository-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" installation: "$ref": "#/components/schemas/simple-installation" sender: "$ref": "#/components/schemas/simple-user" webhook-deployment-review-approved: type: object properties: action: type: string enum: - approved approver: "$ref": "#/components/schemas/webhooks_approver" comment: type: string enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" reviewers: "$ref": "#/components/schemas/webhooks_reviewers" sender: "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: "$ref": "#/components/schemas/webhooks_workflow_job_run" workflow_job_runs: type: array items: type: object properties: conclusion: nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: type: string nullable: true status: type: string updated_at: type: string workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null created_at: type: string format: date-time display_title: type: string event: type: string head_branch: type: string head_commit: type: object nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - workflow_run - since - repository - organization - sender webhook-deployment-review-rejected: type: object properties: action: type: string enum: - rejected approver: "$ref": "#/components/schemas/webhooks_approver" comment: type: string enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" reviewers: "$ref": "#/components/schemas/webhooks_reviewers" sender: "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: "$ref": "#/components/schemas/webhooks_workflow_job_run" workflow_job_runs: type: array items: type: object properties: conclusion: type: string nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: type: string nullable: true status: type: string updated_at: type: string workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null created_at: type: string format: date-time event: type: string head_branch: type: string head_commit: type: object nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string display_title: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - workflow_run - since - repository - organization - sender webhook-deployment-review-requested: type: object properties: action: type: string enum: - requested enterprise: "$ref": "#/components/schemas/enterprise-webhooks" environment: type: string installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" requestor: "$ref": "#/components/schemas/webhooks_user" reviewers: type: array items: type: object properties: reviewer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - id type: type: string enum: - User - Team sender: "$ref": "#/components/schemas/simple-user" since: type: string workflow_job_run: type: object properties: conclusion: nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: type: string nullable: true status: type: string updated_at: type: string required: - id - name - status - conclusion - html_url - created_at - updated_at - environment workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null created_at: type: string format: date-time event: type: string head_branch: type: string head_commit: type: object nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string user_view_type: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string display_title: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - workflow_run - since - workflow_job_run - environment - reviewers - requestor - repository - organization - sender webhook-deployment-status-created: title: deployment_status created event type: object properties: action: type: string enum: - created check_run: type: object nullable: true properties: completed_at: type: string nullable: true format: date-time conclusion: description: The result of the completed check run. This value will be `null` until the check run has completed. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - skipped - null details_url: type: string format: uri external_id: type: string head_sha: description: The SHA of the commit that is being checked. type: string html_url: type: string format: uri id: description: The id of the check. type: integer name: description: The name of the check run. type: string node_id: type: string started_at: type: string format: date-time status: description: The current status of the check run. Can be `queued`, `in_progress`, or `completed`. type: string enum: - queued - in_progress - completed - waiting - pending url: type: string format: uri required: - id - name - node_id - head_sha - external_id - url - html_url - details_url - status - conclusion - started_at - completed_at deployment: title: Deployment description: The [deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments). type: object properties: created_at: type: string creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true environment: type: string id: type: integer node_id: type: string original_environment: type: string payload: oneOf: - type: string - type: object nullable: true performed_via_github_app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - merge_queue_entry - workflow_job - pull_request_review_thread - secret_scanning_alert_location - merge_group external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at production_environment: type: boolean ref: type: string repository_url: type: string format: uri sha: type: string statuses_url: type: string format: uri task: type: string transient_environment: type: boolean updated_at: type: string url: type: string format: uri required: - url - id - node_id - sha - ref - task - payload - original_environment - environment - description - creator - created_at - updated_at - statuses_url - repository_url deployment_status: description: The [deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses). type: object properties: created_at: type: string creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id deployment_url: type: string format: uri description: description: The optional human-readable description added to the status. type: string environment: type: string environment_url: type: string format: uri id: type: integer log_url: type: string format: uri node_id: type: string performed_via_github_app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - merge_queue_entry - workflow_job - merge_group - secret_scanning_alert_location external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at repository_url: type: string format: uri state: description: The new state. Can be `pending`, `success`, `failure`, or `error`. type: string target_url: description: The optional link added to the status. type: string updated_at: type: string url: type: string format: uri required: - url - id - node_id - state - creator - description - environment - target_url - created_at - updated_at - deployment_url - repository_url enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" workflow: "$ref": "#/components/schemas/webhooks_workflow" workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - null - startup_failure created_at: type: string format: date-time display_title: type: string event: type: string head_branch: type: string head_commit: nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - deployment_status - deployment - repository - sender webhook-discussion-answered: title: discussion answered event type: object properties: action: type: string enum: - answered answer: "$ref": "#/components/schemas/webhooks_answer" discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - answer - repository - sender webhook-discussion-category-changed: title: discussion category changed event type: object properties: action: type: string enum: - category_changed changes: type: object properties: category: type: object properties: from: type: object properties: created_at: type: string format: date-time description: type: string emoji: type: string id: type: integer is_answerable: type: boolean name: type: string node_id: type: string repository_id: type: integer slug: type: string updated_at: type: string required: - id - repository_id - emoji - name - description - created_at - updated_at - slug - is_answerable required: - from required: - category discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - changes - discussion - repository - sender webhook-discussion-closed: title: discussion closed event type: object properties: action: type: string enum: - closed discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-comment-created: title: discussion_comment created event type: object properties: action: type: string enum: - created comment: "$ref": "#/components/schemas/webhooks_comment" discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - comment - discussion - repository - sender webhook-discussion-comment-deleted: title: discussion_comment deleted event type: object properties: action: type: string enum: - deleted comment: "$ref": "#/components/schemas/webhooks_comment" discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - comment - discussion - repository - sender webhook-discussion-comment-edited: title: discussion_comment edited event type: object properties: action: type: string enum: - edited changes: type: object properties: body: type: object properties: from: type: string required: - from required: - body comment: "$ref": "#/components/schemas/webhooks_comment" discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - changes - comment - discussion - repository - sender webhook-discussion-created: title: discussion created event type: object properties: action: type: string enum: - created discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-deleted: title: discussion deleted event type: object properties: action: type: string enum: - deleted discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-edited: title: discussion edited event type: object properties: action: type: string enum: - edited changes: type: object properties: body: type: object properties: from: type: string required: - from title: type: object properties: from: type: string required: - from discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-labeled: title: discussion labeled event type: object properties: action: type: string enum: - labeled discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - label - repository - sender webhook-discussion-locked: title: discussion locked event type: object properties: action: type: string enum: - locked discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-pinned: title: discussion pinned event type: object properties: action: type: string enum: - pinned discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-reopened: title: discussion reopened event type: object properties: action: type: string enum: - reopened discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-transferred: title: discussion transferred event type: object properties: action: type: string enum: - transferred changes: type: object properties: new_discussion: "$ref": "#/components/schemas/discussion" new_repository: "$ref": "#/components/schemas/repository-webhooks" required: - new_discussion - new_repository discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - changes - discussion - repository - sender webhook-discussion-unanswered: title: discussion unanswered event type: object properties: action: type: string enum: - unanswered discussion: "$ref": "#/components/schemas/discussion" old_answer: "$ref": "#/components/schemas/webhooks_answer" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - old_answer - repository webhook-discussion-unlabeled: title: discussion unlabeled event type: object properties: action: type: string enum: - unlabeled discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - label - repository - sender webhook-discussion-unlocked: title: discussion unlocked event type: object properties: action: type: string enum: - unlocked discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-discussion-unpinned: title: discussion unpinned event type: object properties: action: type: string enum: - unpinned discussion: "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - discussion - repository - sender webhook-fork: title: fork event description: A user forks a repository. type: object properties: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. allOf: - title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer format: int64 is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility - type: object properties: allow_forking: type: boolean archive_url: type: string archived: type: boolean assignees_url: type: string blobs_url: type: string branches_url: type: string clone_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string created_at: type: string default_branch: type: string deployments_url: type: string description: type: string nullable: true disabled: type: boolean downloads_url: type: string events_url: type: string fork: type: boolean enum: - true forks: type: integer forks_count: type: integer forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string git_url: type: string has_downloads: type: boolean has_issues: type: boolean has_pages: type: boolean has_projects: type: boolean has_wiki: type: boolean homepage: type: string nullable: true hooks_url: type: string html_url: type: string id: type: integer is_template: type: boolean issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string language: nullable: true languages_url: type: string license: type: object nullable: true merges_url: type: string milestones_url: type: string mirror_url: nullable: true name: type: string node_id: type: string notifications_url: type: string open_issues: type: integer open_issues_count: type: integer owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean public: type: boolean pulls_url: type: string pushed_at: type: string releases_url: type: string size: type: integer ssh_url: type: string stargazers_count: type: integer stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string svn_url: type: string tags_url: type: string teams_url: type: string topics: type: array items: nullable: true trees_url: type: string updated_at: type: string url: type: string visibility: type: string watchers: type: integer watchers_count: type: integer installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - forkee - repository - sender webhook-github-app-authorization-revoked: title: github_app_authorization revoked event type: object properties: action: type: string enum: - revoked sender: "$ref": "#/components/schemas/simple-user" required: - action - sender webhook-gollum: title: gollum event type: object properties: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pages: description: The pages that were updated. type: array items: type: object properties: action: description: The action that was performed on the page. Can be `created` or `edited`. type: string enum: - created - edited html_url: description: Points to the HTML wiki page. type: string format: uri page_name: description: The name of the page. type: string sha: description: The latest commit SHA of the page. type: string summary: type: string nullable: true title: description: The current page title. type: string required: - page_name - title - summary - action - sha - html_url repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - pages - repository - sender webhook-installation-created: title: installation created event type: object properties: action: type: string enum: - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repositories: "$ref": "#/components/schemas/webhooks_repositories" repository: "$ref": "#/components/schemas/repository-webhooks" requester: "$ref": "#/components/schemas/webhooks_user" sender: "$ref": "#/components/schemas/simple-user" required: - action - installation - sender webhook-installation-deleted: title: installation deleted event type: object properties: action: type: string enum: - deleted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repositories: "$ref": "#/components/schemas/webhooks_repositories" repository: "$ref": "#/components/schemas/repository-webhooks" requester: nullable: true sender: "$ref": "#/components/schemas/simple-user" required: - action - installation - sender webhook-installation-new-permissions-accepted: title: installation new_permissions_accepted event type: object properties: action: type: string enum: - new_permissions_accepted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repositories: "$ref": "#/components/schemas/webhooks_repositories" repository: "$ref": "#/components/schemas/repository-webhooks" requester: nullable: true sender: "$ref": "#/components/schemas/simple-user" required: - action - installation - sender webhook-installation-repositories-added: title: installation_repositories added event type: object properties: action: type: string enum: - added enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repositories_added: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the installation. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean repository: "$ref": "#/components/schemas/repository-webhooks" repository_selection: "$ref": "#/components/schemas/webhooks_repository_selection" requester: "$ref": "#/components/schemas/webhooks_user" sender: "$ref": "#/components/schemas/simple-user" required: - action - installation - repository_selection - repositories_added - repositories_removed - requester - sender webhook-installation-repositories-removed: title: installation_repositories removed event type: object properties: action: type: string enum: - removed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repositories_added: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the installation. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repository: "$ref": "#/components/schemas/repository-webhooks" repository_selection: "$ref": "#/components/schemas/webhooks_repository_selection" requester: "$ref": "#/components/schemas/webhooks_user" sender: "$ref": "#/components/schemas/simple-user" required: - action - installation - repository_selection - repositories_added - repositories_removed - requester - sender webhook-installation-suspend: title: installation suspend event type: object properties: action: type: string enum: - suspend enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repositories: "$ref": "#/components/schemas/webhooks_repositories" repository: "$ref": "#/components/schemas/repository-webhooks" requester: nullable: true sender: "$ref": "#/components/schemas/simple-user" required: - action - installation - sender webhook-installation-target-renamed: type: object properties: account: type: object properties: archived_at: type: string nullable: true avatar_url: type: string created_at: type: string description: nullable: true events_url: type: string followers: type: integer followers_url: type: string following: type: integer following_url: type: string gists_url: type: string gravatar_id: type: string has_organization_projects: type: boolean has_repository_projects: type: boolean hooks_url: type: string html_url: type: string id: type: integer is_verified: type: boolean issues_url: type: string login: type: string members_url: type: string name: type: string node_id: type: string organizations_url: type: string public_gists: type: integer public_members_url: type: string public_repos: type: integer received_events_url: type: string repos_url: type: string site_admin: type: boolean slug: type: string starred_url: type: string subscriptions_url: type: string type: type: string updated_at: type: string url: type: string website_url: nullable: true user_view_type: type: string required: - id - node_id - avatar_url - html_url action: type: string enum: - renamed changes: type: object properties: login: type: object properties: from: type: string required: - from slug: type: object properties: from: type: string required: - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" target_type: type: string required: - action - target_type - account - changes - installation webhook-installation-unsuspend: title: installation unsuspend event type: object properties: action: type: string enum: - unsuspend enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repositories: "$ref": "#/components/schemas/webhooks_repositories" repository: "$ref": "#/components/schemas/repository-webhooks" requester: nullable: true sender: "$ref": "#/components/schemas/simple-user" required: - action - installation - sender webhook-issue-comment-created: title: issue_comment created event type: object properties: action: type: string enum: - created comment: title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue comment type: string created_at: type: string format: date-time html_url: type: string format: uri id: description: Unique identifier of the issue comment type: integer format: int64 issue_url: type: string format: uri node_id: type: string performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket updated_at: type: string format: date-time url: description: URL for the issue comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id required: - url - html_url - issue_url - id - node_id - user - created_at - updated_at - author_association - performed_via_github_app - body - reactions enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - null assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string type: "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string locked: type: boolean milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer format: int64 login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - labels - state - locked - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user" required: - action - issue - comment - repository - sender webhook-issue-comment-deleted: title: issue_comment deleted event type: object properties: action: type: string enum: - deleted comment: "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - null assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: App description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri user_view_type: type: string required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - "+1" - "-1" - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" issue_dependencies_summary: "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string type: "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer format: int64 login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri user_view_type: type: string required: - login - id assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: title: Label type: object properties: color: description: '6-character hex code, without the leading #, identifying the color' type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string locked: type: boolean milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: "+1": type: integer "-1": type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer format: int64 login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: